Repository navigation
docs: propose documentation maintenance and drift prevention - #2632
Draft
codeforester wants to merge 1 commit into
Draft
codeforester wants to merge 1 commit into
codeforester wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Base's existing document checks did not prevent missing contracts or semantic drift. Propose a design-first documentation lifecycle with explicit ownership, PR impact evidence, executable traceability, and a staged required check.
The proposal follows correction PRs #2629 and #2630. It distinguishes product requirements, high-level design, detailed behavior, decisions, user/reference/operational docs, and derived material. Its eight-category impact record requires affected paths or change-specific no-impact evidence. Material changes receive recorded design acceptance and affected-document drafts before implementation; final docs accompany implementation before merge.
Issue
Fixes #2631
This draft proposes the strategy only. Acceptance, workflow/template adoption, validators, and GitHub enforcement remain separate issue/PR deliverables. Existing #2570/#2572/#2573 and #2566/#2595 are connected without silently changing their scopes or schedules. The remaining manifest-schema gap stays with #1613.
Validation
python -m pytest -q tests/test_documentation_links.py tests/test_contract_hardening.py: 15 passed with the existing Base/base-cli source environment.git diff --checkpassed.Design Impact
Proposed governance design only. The document and index explicitly say it is not adopted policy. Decisions for acceptance include ownership, the first implementation slices, integration with #2572, and record/fragment formats.
Docs Impact
Add
docs/documentation-maintenance-strategy.mdand a clearly proposed link in the documentation index. No runtime behavior, ruleset, workflow, or PR template changes.AI Context Impact
No current-workflow change. Keep AI instructions aligned with active policy; update AGENTS, contributor/workflow guidance, and derived context together in the policy-adoption PR after acceptance.
Release Notes
No user-visible behavior or adopted contributor policy changes. A proposed internal strategy does not need a product release note; the proposal defines future release-note dispositions.
Demo Impact
None. Product and demo behavior are unchanged.