Skip to content

Audit and reconcile documentation with implemented behavior - #212

Merged
pacphi merged 15 commits into
mainfrom
docs/211-implementation-alignment-audit
Sep 9, 2026
Merged

Audit and reconcile documentation with implemented behavior#212
pacphi merged 15 commits into
mainfrom
docs/211-implementation-alignment-audit

Conversation

@pacphi

@pacphi pacphi commented Sep 9, 2026

Copy link
Copy Markdown
Owner

Documentation mixed implemented behavior with proposals, historical snapshots, and unsupported runtime guarantees. This audit reconciles those claims against baseline 67fb5c0 (the #210 squash merge), with a disposition and baseline hash for all 200 tracked documentation/artifact files.

  • Correct ADR status and current-versus-historical boundaries, DDD terminology, host/model/context contracts, privacy/egress/ownership statements, usage formulas and current UI descriptions.
  • Repair contributor/install/Docker instructions, generated CLI/model-help wording, and two active transcript diagrams. Historical screenshots and frozen bodies remain dated evidence.
  • Make 88 links from npm-bundled guides open repository documentation when the target is not shipped. Expand Markdown/link checks to maintainer, Docker and shipped references; check local anchors in CI.
  • Record eight separate implementation follow-up groups. Four have actual-source synthetic reproductions: OpenCode cost undercount, unpaired context chips, lossy legacy router undo, and standalone diagnostic divergence/privacy. This PR does not change their runtime behavior.

Audit report · 200-file inventory · Implementation follow-ups. The report links per-file ADR, DDD, host, dashboard, core and historical/artifact evidence matrices.

Validation

  • Full npm test: 3,829 passed, six skipped, followed by all legacy script suites passing.
  • Typecheck, lint, complexity, Markdown and build checks passed. Routing IDs, tiers, defaults, dispatch, pricing, teardown and authorization logic are unchanged; source edits are documentation text and check configuration.
  • External link sweep: 1,653 references, 774 unique, zero errors; 14 excluded and seven redirects. Expanded offline/anchor checks pass.
  • All 200 inventory hashes match the baseline; no missing owner dispositions. Synthetic reproduction output records its primary-source digests.
  • Field manual and corrected SVGs rendered in Chromium; desktop/narrow layouts checked. All 21 historical PNGs passed integrity/dimension checks; their bytes are unchanged.
  • Independent integration review found no blockers. GitHub CI is green on a7fd01b: all nine OS/Node jobs, quality, browser, expanded internal/anchor links, and both maintainer/consumer devcontainers passed.

Limits

The 88 historical/supporting artifacts have explicit review levels; this is not a claim of re-running every old experiment or validating every historical statement. Twelve frozen relocation-link occurrences remain preserved with successor mappings. No host installation, paid inference, real-user teardown, release, or entitlement probe was performed. Implementation follow-ups are documented, not silently fixed.

Fixes #211. No merge is authorized by this task.

@pacphi
pacphi merged commit 9b75092 into main Sep 9, 2026
15 checks passed
@pacphi
pacphi deleted the docs/211-implementation-alignment-audit branch September 9, 2026 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Audit ADR, DDD, internal and user documentation against implementation

1 participant