Story: Documentation polish
Table of Contents
This page documents a story in Sprint 04. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
Act on the Weaving skills and documentation together analysis: restructure the org-mode docs that produce the website so each page has a clean role, and refresh the Doxygen main page.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent sprint | Sprint 04 |
| Now | Completed 2025-11-30. |
| Waiting on | None. |
| Next | None. |
| Last touched | 2025-11-30 |
Acceptance
- Build instructions live on their own pages, not in the readme.
- Stale navigation, broken links, and stale screenshots fixed.
- Doxygen main page describes the project's API surface usefully.
Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Clean up product website | DONE | 2025-11-30 | 2025-11-30 | Tighten the product website: navigation, broken links, stale screenshots. |
| Update Doxygen main page | DONE | 2025-11-30 | 2025-11-30 | Refresh the Doxygen main page so it links to the v2 entry points instead of the legacy ones. |
Decisions
- Readme is project framing, not a manual
- build instructions and other reference content move to dedicated pages.
Out of scope
- A second pass on the API documentation content itself (Doxygen page refresh only).
See also
- Documentation infrastructure (sprint 01) — predecessor doc story.
- Weaving skills and documentation together (this sprint) — the analysis driving this work.
- How do I deploy the site? — the recipe for the publish target.