Skip to main content
This section holds the policies and templates that govern contributions to docs.optimism.io. Each page is a contract: reviewers cite its sections in docs PRs instead of re-arguing them, so read the pages that match what you are about to write.

Check what belongs on this site

Find the canonical home for what you want to write, and what stays out of the docs entirely.

Write in the site's voice

Match the voice, tone, formatting, and naming conventions every page follows.

Pick the right content type

Use the decision table to choose a content type, then follow its published contract and template.

Link the specs and source correctly

Write cross-repo links in the canonical form the link linter enforces.

Keep curated pages fresh

Follow the review cadence, the last-reviewed contract, and the rule for delisting content that rots.

Add a component hub

Build a new component’s identity page against the uniform hub skeleton.

Change the Learn track

Propose changes to the “Learn the OP Stack” track through its governance artifact.

Looking for something else?

Browse the documentation by role: app developer, chain operator, or node operator.