README
¶
Optimism Monorepo Documentation
The docs/ directory contains Optimism documentation closely tied to the implementation details of the monorepo (https://github.com/ethereum-optimism/optimism).
The directory layout is divided into the following sub-directories.
ai/: AI agent guidance for development in the monorepo.handbook/: Development handbook and guidelines.postmortems/: Timestamped post-mortem documents.public-docs: User facing documentation.security-reviews/: Audit summaries and other security review documents.
Directories
¶
| Path | Synopsis |
|---|---|
|
public-docs
|
|
|
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. |
|
scripts/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.