Documentation
Docs policy
How README, Zola, TypeDoc, and AGENTS.md stay synchronized.
Documentation is distributed by audience.
- Package README files are the package-level source for npm/GitLab consumers.
- Zola pages are the public documentation site and narrative guide layer.
- TypeDoc is generated symbol-level reference.
AGENTS.mdis contributor and agent guidance for repository work.
Minimum sync rules:
- package API change -> package README and relevant Zola page;
- repo onboarding change -> root README and Start pages;
- new or moved guide -> Zola navigation and reference links;
- changed package responsibilities ->
AGENTS.mdand package map.