Documentation Plan¶
The docs are organized around jobs, not internal systems.
Structure¶
| Section | Purpose |
|---|---|
| Start Here | Orient new users and agents. |
| Use SecondPage | Product workflows for access, creating, managing, reviewing, and sharing Pages. |
| Manage | Organization, account, audit, and recovery workflows. |
| Agents | Agent setup, MCP connection, design tools, API keys, exports, and feedback-loop guidance. |
| Reference | Living inventory, coverage audit, docs pipeline, and machine-readable mirrors. |
MkDocs Features To Use¶
- Navigation sections for the main product areas.
- Search for fast lookup across short guides.
- Tables for inventories and settings comparisons.
- Admonitions for safety notes, such as copying API keys once or using private visibility by default.
- Code blocks only where users or agents must copy an endpoint, command, or request shape.
Maintenance Workflow¶
- Update the relevant Markdown page.
- Add or adjust hidden verification notes in frontmatter.
- Run the agent mirror generator.
- Build with strict MkDocs validation.
- Sync the static bundle into the web app.
- Deploy the web app through the normal production release.
- Re-run the Coverage Audit before claiming the full set is complete.
Next Content Passes¶
- Add screenshots generated from the real product.
- Add one complete first-run tutorial for a user.
- Add one complete first-run tutorial for an agent.
- Add troubleshooting pages only after real support questions repeat.