mosaicstack/stack
1
0
Fork 1
Code Issues 246 Pull Requests 7 Actions Packages Projects Releases 15 Wiki Activity

docs: add current sitemap scaffold

Browse Source
This commit is contained in:
Jason Woltje
2026-08-10 16:08:38 -05:00
parent d210c2d7ea
commit 46d29d82e9
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/SITEMAP.md
+14
View File
@@ -1,5 +1,19 @@
# Documentation Sitemap
> **Transition status:** The current structure is listed first. The legacy sections below are retained migration inventory and may contain stale or unresolved paths; they are not a claim that those pages are current.
## Current documentation structure
- [Documentation atlas](README.md) — placement, source-of-truth, linking, and migration rules.
- [User guide index](USER-GUIDE/README.md) — scaffold for end-user documentation.
- [Administrator guide index](ADMIN-GUIDE/README.md) — scaffold for operator documentation.
- [Developer guide index](DEVELOPER-GUIDE/README.md) — scaffold for contributor and architecture documentation.
- [Architecture index](DEVELOPER-GUIDE/architecture/README.md) — scaffold for system design, decisions, and RFCs.
- [API documentation index](API/README.md) — scaffold for the consolidated gateway contract.
- [Documentation catalog and truth audit](reports/documentation/2026-08-10-docs-catalog-audit.md) — evidence and migration recommendations.
Canonical pages added to a book must be linked from that book's README and this section. Replace or retire legacy entries only after the associated migration slice verifies repository references and claim status.
## Compaction refresh lease broker
- [Internal broker protocol](architecture/lease-broker-protocol.md) — kernel identity, ancestry and generation invariants, framed requests, responses, and persisted cycle bindings.
docs/scratchpads/DOCS-IA-002-catalog-audit.md
+5 -2
View File
@@ -18,6 +18,7 @@
- [x] Verify report formatting and scope.
- [x] Commit audit artifacts without unrelated working-tree changes.
- [x] Scaffold audience, architecture, and API indexes without moving legacy content.
- [x] Add current scaffold entry points to `SITEMAP.md` without rewriting its legacy sections.
## Initial findings
@@ -30,7 +31,8 @@
- TUI documents reference missing `packages/cli` and a missing historical worktree; current TUI code is under `packages/mosaic`.
- `docs/openapi-tess.yaml` parses as OpenAPI 3.1 with 17 paths, but remains a legacy root-level Tess-scoped contract rather than the full API SSOT.
- `.gitignore` ignores `docs/reports/`, conflicting with the new documentation contract; the audit report must be force-added and ignore remediation deferred to a separate change.
- The scaffold slice adds `USER-GUIDE/README.md`, `ADMIN-GUIDE/README.md`, `ADMIN-GUIDE/security/README.md`, `DEVELOPER-GUIDE/README.md`, `DEVELOPER-GUIDE/architecture/README.md`, and `API/README.md`; legacy pages and `SITEMAP.md` remain unchanged.
- The scaffold slice adds `USER-GUIDE/README.md`, `ADMIN-GUIDE/README.md`, `ADMIN-GUIDE/security/README.md`, `DEVELOPER-GUIDE/README.md`, `DEVELOPER-GUIDE/architecture/README.md`, and `API/README.md`; legacy pages remain unchanged.
- `SITEMAP.md` now has a labeled current-structure section; its legacy sections remain unchanged and explicitly transitional.
## Method
@@ -60,4 +62,5 @@
| Scoped commit | PASS — audit plan, report, and scratchpad committed together; `.mosaic/orchestrator/*` remains outside the commit |
| Report formatting and scope | PASS — `pnpm exec prettier --ignore-path /dev/null --check` passed; ignored report path identified and force-add is required |
| Commit hook behavior | FINDING — lint-staged emitted an ignored `docs/reports` path error during commit even though the report was force-staged; remediation remains open |
| Index scaffold | PASS — six indexes formatted, all new Markdown/wikilinks resolve, target directories exist, and legacy pages plus `SITEMAP.md` were not changed |
| Index scaffold | PASS — six indexes formatted, all new Markdown/wikilinks resolve, and target directories exist; legacy pages were not changed |
| Sitemap scaffold | PASS — additive current section is formatted, all seven links resolve, and legacy sections are unchanged |