Docs
Docs overview
Chapter 04 · generate and maintain project documentation.
The Docs chapter generates documentation from your code (README, architecture, API reference, runbooks) and tracks when it goes stale. It's an AI doc writer paired with a drift detector, plus a markdown editor, live preview, and one-click export.
Docs unlocks once you've started building in Code.
What it does
- AI doc generation: README, Architecture, API, Runbook, and more, drafted from your code.
- Drift detection: flags which docs went stale when the project changed.
- Markdown editor: edit raw, preview rendered.
- Export: bundle every doc into one markdown file.
- Smart suggestions: a doc set proposed for an empty project.
- Pitch deck: flip to Deck view to generate an investor-ready presentation from the same project context.
The layout
- A rail listing your docs, grouped into core docs (README, Architecture, API, Runbook) and custom docs, each with a status pip.
- A content area that renders the active doc (or edits it raw).
- A chat panel for asking Modus to draft, refresh, or rewrite.
Doc statuses
| Status | Means |
|---|---|
| current | Up to date |
| drifting | A project change may have made it stale |
| empty | No content yet |
The pages ahead
- Generating docs: propose, bootstrap, draft
- Drift detection: how staleness is flagged
- Editing & export: the editor and bundling
- Pitch deck: generate a presentation from your project