Repository navigation
Description
Problem
The accepted Base governance design and implementation plan identify package 11c as a required deliverable. This issue translates that package into a reviewed, bounded issue/PR train; it does not authorize implementation before the issue reaches Ready.
Expected behavior
Add evidence-only checks for user guides, README/FAQ, command/API/config reference, operational/security guidance and examples using the canonical inventory and path map. Report missing impact destinations, stale command/reference links and affected examples. The README is updated last; the checker does not generate or silently rewrite documentation.
Scope and non-goals
Scope: Add evidence-only checks for user guides, README/FAQ, command/API/config reference, operational/security guidance and examples using the canonical inventory and path map. Report missing impact destinations, stale command/reference links and affected examples. The README is updated last; the checker does not generate or silently rewrite documentation.
Non-goals: Do not silently expand scope, activate unreviewed policy, mirror issue fields onto PRs, grant agents merge/release authority, or make changes outside the named affected areas. Any new product decision or materially new work gets a separate issue and decision record.
Affected areas
- Docs contract checks, user/reference docs, README/FAQ, operational docs and examples.
- Accepted source: governance design and implementation plan, PR #2664
- Parent tracker: #2665
Impact and evidence
- Product intent: Implements only the accepted governance design and plan; any product-requirement change must be filed separately.
- Architecture and contracts: Destination is the package-specific section of the merged governance design/implementation plan plus the affected canonical contract named above.
- User guidance: The issue identifies likely guidance paths; the implementation PR must name updated user/FAQ/README paths or give a change-specific reason why none is affected.
- CLI/API and reference: The affected-area list determines whether CLI/API/reference docs change; the implementation PR must cite the exact reference path or justify no impact.
- Operations and safety: No privileged automation or merge authority is implied; the PR must list operational/security effects and any rollback.
- Validation and testing: The issue lists the planned tests; the PR must report executed validation and explain any unavailable test.
- Examples and downstream use: The implementation PR must identify affected examples/consumers or give evidence that this change has no downstream surface.
- Governance and contributor process: This package changes or preserves the contributor/governance contract as described in Scope; links must point to the canonical rules.
- Decision records: No new decision is accepted by this issue; any durable deviation requires a proposed decision record and explicit maintainer acceptance.
- Release notes: The PR must include a user-facing release-note line or a reasoned
none; this issue does not pre-decide that disposition.
These are issue-stage dispositions to refine during Triage. Before Ready, every category must have its exact destination or evidence-based no-impact reason; the PR repeats the ten-category evidence for actual changes.
Open questions
- None known. If implementation exposes an unresolved contract, return this issue to Triage and record the decision before implementation continues.
Plan
- S1: One focused PR for this issue. Use
Fixes #Nonly if no additional slice is needed; if the maintainer approves multiple PRs, name eachS1…Snhere before the first is opened and usePart of #N. - Dependencies: the P11a issue
- Acceptance criteria:
- Each supported doc kind resolves to a canonical owner and impact path.
- Changed CLI/config/example paths surface relevant user/reference/runbook/example documents and missing or stale links.
- Findings include evidence and a reasoned no-impact path; no semantic claim is auto-approved.
- README is treated as a navigation/summary surface updated after canonical details.
- Validation:
- Fixture coverage for CLI option, configuration, user-guide, FAQ, operations and example changes.
- Verify stale links and missing destinations are reported without editing files.
- Run representative warn-only corpus and review false-positive/negative limits.
- Risks and rollback: Surface-level matching may miss behavior changes; require human review and retain disabled/warn-only rollback.
- Decision impact: No decision is accepted merely by implementing the issue. Record the relevant accepted decision/ADR and file a superseding record if the maintainer approves a change.
Metadata
Metadata
Assignees
Labels
Type
Projects
- StatusShow more project fieldsBacklog
Activity
codeforester commentedon Nov 11, 2026
Pre-Triage review against the accepted plan (#2664, tracker #2665)
tests/test_documentation_links.pyand the doc-contract tests (test_*_docs.py) already cover some of this. Extend them rather than building a parallel system.Dependencies text. Replace
the P11a issuewith #2676. The native blocked-by links are already correct; the body is what a reviewer reads.Contract text. The Impact, Scope and Open questions sections are still the shared template text. The Impact section is identical in 24 of #2666–#2690, and Scope repeats Expected behavior. That's fine in Backlog. Before Ready, replace each with this issue's own dispositions.
Claude Code (Opus 5.5), reviewing from Ramesh's account at his request. This review comes before Triage, so it is not an issue-loop round.