docs: migrate performance evidence report

This commit is contained in:
Jason Woltje
2026-08-10 16:16:31 -05:00
parent 46d29d82e9
commit 94fc3e55f5
5 changed files with 26 additions and 18 deletions
+16 -12
View File
@@ -19,6 +19,7 @@
- [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.
- [x] Select the P8-003 performance report as the first low-risk migration slice.
## Initial findings
@@ -33,6 +34,7 @@
- `.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 remain unchanged.
- `SITEMAP.md` now has a labeled current-structure section; its legacy sections remain unchanged and explicitly transitional.
- `docs/PERFORMANCE.md` had no live source/test dependency or internal links; it moved unchanged to `docs/reports/qa/p8-003-performance-optimization.md`. The admin index and current sitemap now classify it as historical evidence, not an operator runbook.
## Method
@@ -52,15 +54,17 @@
## Verification log
| Check | Result |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| File inventory | PASS — 11 root files, 269 archived files, plus task artifacts |
| Initial link audit | FINDING — 219 links, 98 unresolved |
| Code-surface audit | PASS — corrected manifest/script and legacy-reference scans; first attempt was discarded due to a `require()` path bug |
| Truth probes | PASS — root docs, SSO, performance, TUI, OpenAPI, and source-path evidence triaged |
| Final report | Written — `docs/reports/documentation/2026-08-10-docs-catalog-audit.md` |
| 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, 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 |
| Check | Result |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| File inventory | PASS — 11 root files, 269 archived files, plus task artifacts |
| Initial link audit | FINDING — 219 links, 98 unresolved |
| Code-surface audit | PASS — corrected manifest/script and legacy-reference scans; first attempt was discarded due to a `require()` path bug |
| Truth probes | PASS — root docs, SSO, performance, TUI, OpenAPI, and source-path evidence triaged |
| Final report | Written — `docs/reports/documentation/2026-08-10-docs-catalog-audit.md` |
| 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, 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 |
| First migration selection | PASS — P8-003 report selected as a no-rewrite evidence migration; live references identified before move |
| P8-003 migration | PASS — destination is byte-identical, live references were updated, formatting and navigation checks pass, and only the scoped migration files are pending commit |