Official documentation for MegaETH, hosted at docs.megaeth.com.
Documentation is written in GitBook-flavored Markdown and deployed via GitBook with Git Sync.
docs/ Documentation source
├── README.md Landing page
├── SUMMARY.md Table of contents / navigation
├── architecture.md Architecture overview
├── mini-block.md Mini-block design
├── user/ User Guide (wallets, bridging, getting started)
└── dev/ Developer Docs (gas model, RPC, debugging)
├── send-tx/ Submitting transactions
├── read/ Reading from MegaETH (RPC, realtime API)
└── execution/ EVM differences, gas model, resource limits
CI runs three checks on all Markdown files:
| Tool | What it checks | Config |
|---|---|---|
| lychee | Internal links resolve to existing files | lychee.toml |
| markdownlint | Markdown structure (blank lines, heading style, bare URLs) | .markdownlint-cli2.yaml |
| Prettier | Consistent formatting (tables, spacing, indentation) | .prettierrc.yaml |
To run locally:
# Install tools via mise (one-time setup)
mise install
# Run all checks
mise run lint
# Auto-fix formatting
mise run fmt- Edit or create Markdown files under
docs/. - Update
docs/SUMMARY.mdif adding or removing pages. - Run
mise run fmtto format, thenmise run lintto verify. - See
AGENTS.mdfor writing conventions and layer-specific rules.
