Skip to content

[AI:codex] docs(audit): complete the documentation freshness and navigation audit (TASK-B6B1278890774EF993D2EBC327862470-113) - #3103

Open
joemooney wants to merge 6 commits into
task-b6b1278890774ef993d2ebc327862470-112-workfrom
task-b6b1278890774ef993d2ebc327862470-113-work
Open

joemooney wants to merge 6 commits into
task-b6b1278890774ef993d2ebc327862470-112-workfrom
task-b6b1278890774ef993d2ebc327862470-113-work

Conversation

@joemooney

@joemooney joemooney commented Oct 29, 2026 •

Copy link
Copy Markdown
Owner

The audit covers 1,017 tracked documentation inputs and 2,585 local links, with zero candidates in the focused current set. The 220 contextual/template/historical candidates remain unconfirmed. Fixes include overview/index/positioning links, cache and initialization wording, historical labels and linked review-process wording for the verified human exception. The standalone overview now regenerates with build.py --overview and an editable design shell; this optional route requires Pandoc. Inventory, link candidates, hashes and the coverage report are reproducible without hardcoded pre-squash revision commands.

Rebuilt on current main (1db74dba112) after advisor feedback; only this slice's changes follow PR #3102. Pre-squash prerequisite commits were not replayed.

Validation: make check-ci-fast completed all 35 gates for this rebuilt head. Each slice's generated guide output reproduced. The final stack's guide/search/overview builds and audit reproduced in isolated author-check copies; desktop/mobile overview screenshots were inspected. No direct cargo, protected runtime changes, deployment or self-merge.

Author self-check: two fresh contexts; the first found stale human-exception wording in a linked guide, corrected in the final audit slice; the second found no remaining issues. These are author checks, not independent approval. Fresh independent review at each new head is required; the advisor integrates bottom-up.

…gation audit (TASK-B6B1278890774EF993D2EBC327862470-113)
…dance (TASK-B6B1278890774EF993D2EBC327862470-113)
…view exception (TASK-B6B1278890774EF993D2EBC327862470-113)
… (TASK-B6B1278890774EF993D2EBC327862470-113)
@joemooney
joemooney force-pushed the task-b6b1278890774ef993d2ebc327862470-113-work branch from 6e72a0d to d225780 Compare October 30, 2026 00:36
@joemooney
joemooney force-pushed the task-b6b1278890774ef993d2ebc327862470-112-work branch from b2c511e to 742acec Compare October 30, 2026 00:36
@joemooney

Copy link
Copy Markdown
Owner Author

Review: PR-3103 (round 1, head d22578011b4)

Spec Verdict Evidence
TASK-…-113 ✅ PASS see per-criterion lines
  • AC1 inventory/classification/snapshot: verified. docs/audit-documentation.py --base 1db74dba regenerates the inventory, links and snapshot CSV/JSON byte-identically: 1,017 files, 2,585 links, 220 candidates. The docs/archive|plans|reports historical sets are classified as evidence and none were edited.
  • AC2 sweep/verify against source/help: verified. The script reports zero focused candidates (FOCUSED LINK CANDIDATES: []). I spot-checked these against the real files and help output: aida init --help (--with-mcp opt-in), the WORK per-type allocation in allocation_authority.rs, the review-process #solo-projects--audited-self-approval section, the glossary anchors (12-glossary.md L17/69/456/485), the README #what-it-provides anchor and the docs index anchor #3-deciding-whether-to-adopt.
  • AC3 bounded fixes + gaps reported: verified. The changes are small, targeted link and wording edits. The report's "Remaining gaps" section lists what wasn't re-tested (external URLs, vendor installs, assistive technology).
  • AC4 concise report: verified. docs/reports/2026-10-29-documentation-review.md points to the Git diff and doesn't copy whole documents.
  • AC5 static site + no new gate/hosting: verified. Rebuilding with build.py gives a docs/showcase tree identical to the PR. build.py --overview (Pandoc) reproduces what-is-aida.html identically. The landing and library pages link to the assessment. No CI, workflow or hosting files are touched.

CI: this PR is stacked on the slice-112 branch, so the only CI that ran was merge-hold-gate (green). I ran make check-ci-fast locally at the head: 35/35 gates passed.

Non-blocking nits: (1) The report's reproduction commands use --base origin/main and a two-dot git diff origin/main..HEAD. Both refs move, and the diff also pulls in slices 106–112. They should pin 1db74dba and use a three-dot diff from the PR base. (2) The broken admin-guide link is rated "Critical", above the onboarding misstatements; the severity looks inverted. (3) In build.py, import sys is inside the __main__ block.

Recommendation: approve. Integrate bottom-up after #3102.

…0774EF993D2EBC327862470-113)

# Conflicts:
#	docs/showcase/build.py
#	docs/showcase/index.html
…checks (TASK-B6B1278890774EF993D2EBC327862470-113)
@joemooney

Copy link
Copy Markdown
Owner Author

Review: PR-3103 (round 2, head fcd2f35975c): ⚠️ request changes

Spec Verdict Evidence
TASK-…-113 ⚠️ PARTIAL link/anchor/CLI fixes verified; the regenerated overview loses accessibility semantics

Acceptance criteria

  • AC1 inventory/classification/snapshot: verified. docs/audit-documentation.py --base 1db74dba… regenerates all four artifacts byte-identically: 1,017 inputs, 2,591 links, 220 candidates and zero focused candidates. No docs/archive|plans|reports historical file is edited.
  • AC2 sweep and source/help verification: partial. All changed anchors resolve (07-project-setup.md:555, review-process.md:240, README.md:39, 12-glossary.md L17/69/456/485, README.md:11, cli/01-getting-started.md:9). aida init --help (--with-mcp, --agent PATH detection), aida protocol seed, aida cache status|rebuild and the default non-authoritative allocation in allocation_authority.rs::resolve confirm the wording. The overview accessibility regression below was not caught.
  • AC3 bounded fixes and reported gaps: verified apart from the regression below.
  • AC4 concise report: partial. Line citations for first-project.md:53,69,86 are stale (the changes are at 49-52, 65 and ~80-86). The report does not record the overview semantic changes.
  • AC5 static site, reachability, no new gate or hosting change: partial. The 9 fixtures pass, and build.py --check and --overview --check both return 0. The landing page reaches every primary topic (setup through library/nav). This PR's diff has no CI or hosting change (the ci.yml step comes from slice 111). However, the final overview HTML regresses.

Findings

  1. [major] Overview accessibility regression. build.py render_overview() produces what-is-aida.html without the semantics on the base and on main. The counts:

    • <th scope="col">: 35 → 0 (main has 39)
    • section aria-labelledby: 25 → 0
    • heading anchor links: 7 → 0

    The per-table region names are replaced by 11 identical aria-label="Scrollable data table" landmarks, and the nested TOC is flattened.

  2. [minor] Heading structure. # Appendices now renders as a second <h1> mid-document. It is missing from the TOC (the base rendered <h2 class="appendices-title">). The "In one sentence" callout-sentence wrapper is also lost.

  3. [minor] Report evidence. The line citations are stale, and the accessibility claims should record finding 1.

  4. [cosmetic] index.html:101: only the first text-link arrow is aria-hidden. Five other internal links, including the new assessment link, still expose a bare ↗.

CI: stacked on slice 112, so only merge-hold-gate ran (green). I ran the showcase fixtures and both --check modes locally; all passed.
Recommendation: rework, with aida rework TASK-B6B1278890774EF993D2EBC327862470-113 --work --resume --reason "restore overview a11y semantics; fix report citations".

@joemooney joemooney added aida:merge-hold Supervised merge hold — merge-hold-gate fails while present aida:merge-hold-recorded Supervised merge hold was recorded — persists across clearance labels Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aida:merge-hold Supervised merge hold — merge-hold-gate fails while present aida:merge-hold-recorded Supervised merge hold was recorded — persists across clearance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant