Generate docs from a codebase
Turn a sealed codebase into READMEs, references, and diagrams with ArxDocs.
This guide generates documentation from a private codebase with ArxDocs. The source is read only inside the boundary.
1. Generate
arxcode docs ./my-service --output ./docs
ArxDocs reads your code inside the seal and produces structured documentation — a README, an API reference, and architecture notes.
2. Choose tone & audience
Generate internal-only or public-facing docs from the same source:
arxcode docs ./my-service --audience public
3. Add diagrams
ArxDocs can render flowcharts, architecture, and data-model diagrams alongside the prose — useful for onboarding and design review.
4. Export
Export to Markdown, Confluence, or PDF in one action:
arxcode docs ./my-service --export markdown
Nothing retained
As with every build, the source is destroyed when generation completes — only the documentation you export persists.