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.