Documentation Standard
This repository's documentation must describe the real implementation on the current branch.
Rules
- Provide
README.md,doc_standard.md, and structured package or subsystem documents for every supported locale. - Document only APIs, workflows, and design decisions that exist in the current branch.
- Keep the directory layout aligned with real package or subsystem boundaries.
- Each package or subsystem directory must contain
api.md,tutorial.md, anddesign.md. - Keep examples small enough to maintain and close enough to real usage that they can be tested or manually verified.