Documentation Standard
Documentation must describe the current branch rather than planned APIs.
Structure
- Localized documentation lives under
doc/en_US,doc/zh_CN, anddoc/ja_JP. - English is the structural baseline; translations keep matching relative paths.
- Each documented package uses
api.md,design.md, andtutorial.md. README.mbt.mdgives a short package-local entry point.pkg.generated.mbtiis authoritative for MoonBit public signatures.
Responsibilities
api.mdlists callable behavior and observable results.tutorial.mdshows the shortest realistic workflow.design.mdrecords ownership, invariants, effects, and explicit limitations.verification.mdrecords reproducible evidence without overstating coverage.
Commands, identifiers, package paths, schema names, and version numbers remain unchanged across translations. A capability must not be documented as complete until code and focused tests exercise it.