Skip to content

docs: reconcile audited design and implementation drift #2628

Open

Description

@codeforester

Goal

Reconcile confirmed documentation drift from the 18 October design/code audit against current main, without changing runtime behavior.

Background

The audit found inconsistent descriptions across canonical design, user guidance, examples, ownership documentation, and AI context. Current main still contains these discrepancies. Passing existing contract tests does not establish that the prose is accurate.

Scope

Acceptance Criteria

  • Each listed finding has a concrete documentation correction or an explicit maintainer decision recorded in the PR.
  • Runtime ownership and consent procedures agree across affected canonical and derived documents.
  • Release recovery describes prerequisites, original BOM/tag authority, failure boundaries, and idempotent resume without weakening the first-time provenance contract.
  • Uninstall docs distinguish selected resource removal, retained state, checkout identity, verification limits, and partial failures.
  • The two current YAML examples pass the production parsers.
  • Ownership covers every tracked Python package and names the actual provider boundary.
  • Workspace docs distinguish setup/test process-group handling from update subprocess handling.
  • Existing relevant documentation/contract checks and git diff --check pass.

Validation

Compare the documentation against current implementation and regression tests. Run the existing relevant documentation tests, focused routing/IDE/release/uninstall/workspace tests, and the production parsers against the corrected fenced YAML blocks. No real install, release publication, or uninstall is required.

Non-Goals

Project Fields

  • Status: In Progress
  • Priority: P1
  • Size: M
  • Area: Docs
  • Initiative: Contract Hardening
  • Milestone: v1.11.0

Agent Assignment

Owner: Codex, with codeforester as accountable maintainer. Use one dedicated issue-backed documentation worktree. Validate and open a reviewable PR; do not merge without authorization. Preserve unrelated worktrees and the primary checkout.

Activity

  1. self-assigned this
    on Oct 21, 2026
  2. moved this to Backlog in baseon Oct 21, 2026
  3. added this to the v1.11.0 milestone on Oct 21, 2026
  4. moved this from Backlog to In Progress in baseon Oct 21, 2026
  5. moved this from In Progress to In Review in baseon Oct 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type

Projects

  • Status
    In Review

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions