Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Section for Standard Config #1187

Open
ZakAyesh opened this issue Dec 20, 2024 · 4 comments
Open

Section for Standard Config #1187

ZakAyesh opened this issue Dec 20, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ZakAyesh
Copy link
Contributor

Brief Description of the Docs Request

We should have a section describing the standard configuration.

Description of the Documentation You'd Like

I see this as a section to add under the "OP Stack" section which explains what standard configuration is. We can then explain that OP-Deployer does a lot of the work to ensure you are deploying a standard config-compliant chain. We should also link out to the superchain registry.

Links to Related Pages

https://specs.optimism.io/protocol/configurability.html
https://github.com/ethereum-optimism/superchain-registry

Additional Context

In dev support we get many questions asking what is and isn't standard configuration. i.e. we had a partner asking if custom gas token is currently considered standard config (it isn't).

@ZakAyesh ZakAyesh changed the title Support for custom gas tokens with op-deployer Section for Standard Config Dec 20, 2024
@ZakAyesh ZakAyesh added the documentation Improvements or additions to documentation label Dec 20, 2024
@sbvegan
Copy link
Collaborator

sbvegan commented Dec 23, 2024

Good call out! Here's a PR that will address this issue: #1125

@krofax
Copy link
Contributor

krofax commented Jan 3, 2025

@sbvegan This PR doesn't seem to align with the standard configuration @ZakAyesh mentioned. Would you like me to create a new PR?

If it meets expectation then we can close this issue?

@sbvegan
Copy link
Collaborator

sbvegan commented Jan 3, 2025

Description

To address this issue, lets add a sub section to the blockspace charter/standard charter section of our documentation to address devsup's recurring question about standardization.

User story

  • A chain governor should be able to understand what defines a standard chain (on a technical and governance level)

Resources

  • Standard Rollup Configuration Page
  • Zak and other developer support engineers who have gotten this question
  • Tess is the product manager on the superchain registry and knows a lot about standarization

Acceptance Criteria

  • A new section that describes what a standard chain is and links out to the specs to explicity defines the technical stuff
  • Information about the op-deployer and how it helps with standardization
  • Why standardization is important
  • Context on what is and what is not standard

Action items

  1. Reach out to Zak and devsup if you need more context
  2. Open a PR to add context that addresses the acceptance criteria
  3. Get review from zak and tess
  4. peer review merge
  5. If needed, open a new issue for next sprint about opening a PR to the specs site to organize the standard config info.

@krofax
Copy link
Contributor

krofax commented Jan 17, 2025

@ZakAyesh @tessr @sbvegan Ready for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants