mosaicstack/stack
25
0
Fork 1
Code Issues 340 Pull Requests 13 Actions Packages Projects Releases 15 Wiki Activity

docs: promote lease broker architecture contracts

Browse Source
This commit is contained in:
Jason Woltje
2026-08-10 17:41:40 -05:00
parent 4aa67e8dff
commit 0da1deb83f
8 changed files with 59 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/scratchpads/DOCS-IA-002-catalog-audit.md
+21 -18
View File
@@ -36,6 +36,7 @@ The four isolated worktrees were clean and removed after report collection.
- [x] Archive the contradicted TUI PRD/task pair with unchanged content and an explicit archive index.
- [x] Create and promote the verified user quickstart from the empty root placeholder.
- [x] Rewrite and promote the SSO administrator runbook from current auth/web source evidence.
- [x] Promote the lease-broker protocol and compaction-revocation contracts with their acceptance-test path consumers.
## Initial findings
@@ -54,6 +55,7 @@ The four isolated worktrees were clean and removed after report collection.
- `PRD-TUI_Improvements.md` and `TASKS-TUI_Improvements.md` had no live source/test dependencies beyond their internal relative link; both moved unchanged to `docs/archive/tui/`, and `docs/archive/README.md` labels them historical.
- The empty `docs/QUICKSTART.md` placeholder was replaced by `docs/USER-GUIDE/getting-started/quickstart.md`, based on verified installer, wizard, CLI, and runtime-safety behavior. The page explicitly excludes held PostgreSQL/source-checkout routes.
- The SSO guide now documents Authentik/WorkOS/Keycloak discovery, OIDC callbacks, Keycloak SAML fallback, partial-config failures, and the absence of frontend feature flags. The root guide and stale `.env.example` flags were removed.
- The lease-broker acceptance suites directly consumed two quarantined `docs/architecture/` paths; promoting the protocol and compaction-revocation contracts to `DEVELOPER-GUIDE/architecture/` and updating those consumers restored the intended contract paths without changing runtime behavior.
## Method
@@ -73,21 +75,22 @@ The four isolated worktrees were clean and removed after report collection.
## 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 |
| 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 |
| TUI archive migration | PASS — both pages are byte-identical, internal links and archive navigation resolve, formatting passes, and only the scoped archive files are pending commit |
| Quickstart migration | PASS — current page content is source-checked, held routes are labeled, navigation resolves, root placeholder is removed, and formatting passes |
| SSO migration | PASS — auth/gateway/web SSO tests pass (15+2+2), source claims and navigation resolve, obsolete env flags are removed, and the root guide is retired |
| Parallel Pi audits | PASS — four requested `openai-codex/gpt-5.6-luna:max` read-only lanes completed in clean isolated worktrees; no agent changes were imported |
| 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 |
| TUI archive migration | PASS — both pages are byte-identical, internal links and archive navigation resolve, formatting passes, and only the scoped archive files are pending commit |
| Quickstart migration | PASS — current page content is source-checked, held routes are labeled, navigation resolves, root placeholder is removed, and formatting passes |
| SSO migration | PASS — auth/gateway/web SSO tests pass (15+2+2), source claims and navigation resolve, obsolete env flags are removed, and the root guide is retired |
| Parallel Pi audits | PASS — four requested `openai-codex/gpt-5.6-luna:max` read-only lanes completed in clean isolated worktrees; no agent changes were imported |
| Lease-broker architecture | PASS — two contract pages promoted, two source/test consumers and navigation updated, 20/20 Vitest acceptance tests passed, and the 3-test Python portability suite passed |