Read the reference documentation across ten sections, from concepts and protocol through agents, the human plane, platform, interop and operators. Every page cites the repository paths its statements come from, so you can check a claim against the code behind it. Pages also record what is absent: which SDKs expose no register or faucet call, and that the limited beta has not opened. Broken links and unreachable pages fail the pull request, not your reading.

What it does

The repository builds its developer documentation with MkDocs and the Material theme from docs/site. The page sources are 79 Markdown files under docs/site/docs, arranged in ten navigation sections: Overview, Concepts, Protocol, Programs, Agents, Human, Platform, Interop, Operators and Reference. A GitHub Actions workflow runs mkdocs build --strict on every pull request that touches docs/, and a push to main deploys the built site to GitHub Pages. A separate standalone script, docs/site/build_wiki.py, renders the older docs/wiki tree to static HTML and refuses to finish if any relative Markdown link is broken.

Key capabilities

• MkDocs Material site with search, tabbed content, code copy and a light/dark palette toggle.
• Ten navigation sections spanning concepts, protocol, programs, agents, human plane, platform, interop, operators and reference.
• Strict build in CI on every documentation pull request; pushes to main publish to GitHub Pages.
• build_wiki.py renders the wiki to HTML and exits non-zero listing each broken relative link.
• Seven localized READMEs (de, es, fr, ja, pt-BR, ru, zh-CN) mirrored under overview/i18n.
• Pages cite the repository paths behind their claims and state where a surface is absent.

Differentiators

Pages record absent surfaces rather than omitting them: docs/wiki/SdkQuickstarts.md names, per language, which SDKs expose no register or faucet call and which tree a given SDK does not ship in, and docs/wiki/PublicAPI.md states that the limited beta has not opened and that no general-use faucet is run.

Outcomes

• Check any documented claim against the repository path the page cites
• Trust the navigation, since a broken link fails CI before it ships
• Find out where a surface is missing, as well as where it exists

Technical notes

• Python toolchain, not Node and not Docusaurus: mkdocs==1.6.1 and mkdocs-material==9.6.22, built with Python 3.12 in CI.
• mkdocs.yml sets strict: true and warns on omitted files, unrecognized links and anchors; mkdocs commands must run from docs/site so they read that config.
• Two parallel trees are maintained: docs/site/docs holds the published pages, docs/wiki holds 79 CamelCase-named pages of the same material. docs/site/README.md directs new documentation to docs/site/docs; no checked-in script copies between the trees, and build_wiki.py writes only to the uncommitted docs/site/out.
• The seven SdkQuickstart*.md pages (Rust, TypeScript, Python, Go, JVM, Swift, .NET) exist only in docs/wiki, so the published site has an SDK overview page and no per-language getting-started page.
• docs/evm_jsonrpc_unsupported.md sits outside the site navigation, and docs/runbooks/ holds exactly one runbook, for the Paxeer X fork validator upgrade.
• Hardhat has zero mentions anywhere under docs/site/; its only documentation reference is a link-table row in docs/paxeer-chain-docs.md. Translation coverage is README and overview level only. The wiki pages themselves are not translated, and the English README is authoritative where a localized copy differs.

cd docs/site
python3 -m venv .venv && . .venv/bin/activate
pip install -r requirements.txt
mkdocs build --strict
python3 build_wiki.py

More in Developers