README
¶
Optimism Docs
This directory houses the Optimism Docs located at docs.optimism.io. All documentation-related updates and new content will be tracked and maintained here, within the ethereum-optimism/optimism monorepo.
Local Development
Follow these mintlify docs to preview and edit the documentation page locally.
License
This project is licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
scripts
|
|
|
gen-deploy-config
command
Command gen-deploy-config generates the MDX schema reference for the OP Stack DeployConfig — the flat JSON deployment configuration defined by the DeployConfig struct tree in op-chain-ops/genesis — so the docs schema reference is derived from the Go struct tags and doc comments instead of hand-transcribed.
|
Command gen-deploy-config generates the MDX schema reference for the OP Stack DeployConfig — the flat JSON deployment configuration defined by the DeployConfig struct tree in op-chain-ops/genesis — so the docs schema reference is derived from the Go struct tags and doc comments instead of hand-transcribed. |
|
gen-flags
command
Command gen-flags generates MDX flag-reference tables for OP Stack Go services from their urfave/cli flag definitions, so the docs flag catalogs are derived from source instead of hand-transcribed from `--help` output.
|
Command gen-flags generates MDX flag-reference tables for OP Stack Go services from their urfave/cli flag definitions, so the docs flag catalogs are derived from source instead of hand-transcribed from `--help` output. |
Click to show internal directories.
Click to hide internal directories.