Repository navigation
docs: centralize repository knowledge and enforce upkeep in CI - #292
Merged
Merged
Conversation
laipz8200
enabled auto-merge (squash)
September 10, 2026 09:31
QuantumGhost
approved these changes
Sep 10, 2026
Contributor
|
Besides, how about using frontmatter to track last check time? This might simplify the handling of |
This was referenced Sep 17, 2026
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
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.
Important
!Related Issue
Closes #291
Summary
Completed plans, resolved debt, and repeated rule descriptions made active repository knowledge harder to maintain. Archive the four completed plans under
docs/archive/plans/, remove resolved debt from active guides, and preserve reusable guidance through links to its stable home. Archive contents are excluded from routine knowledge checks; active links into the archive must still resolve.Add maintenance principles requiring script-verifiable constraints to be enforced in CI and each fact to have one authoritative definition. Review all 12 active pages, replace duplicated setup instructions, API inventories, import rules, metadata specifications, and lifecycle constraints with links to their owning guide, implementation, configuration, or tests. Keep human review guidance and a distinct full-inspection workflow in
docs/maintenance.md.Close enforcement gaps: check local Markdown heading links, validate PR body headings/checklist against the PR template and require an issue reference, preserve existing historical runtime/engine fixture bytes, and reject the example's local credentials file if tracked. Ignore that credentials path locally as well. The PR body is read as JSON data; no PR text is interpolated into shell commands. Existing PR title, package, import, release, and review-age checks remain authoritative for their rules.
The scheduled inspection on 2026-09-10 fetched default-branch revision
4b95906into a fresh worktree and continued this existing PR atc29545b. All 12 active pages were rechecked against source, tooling, tests, and relevant tracking status. No new content corrections were needed; this run updates their review timestamps and leaves archived pages untouched. The README cleanup overlaps the narrow validation-summary change in #288. No engine behavior changes.Validation on Python 3.12.13:
uv run pytest -n 0 tests/engine/test_event_stream.py tests/test_repository_docs.py tests/test_pull_request_checks.py: 53 passed.just test: 889 passed on rerun. The initial run had 887 passes and two 10-second gevent subprocess timeouts; both cases passed unchanged in the targeted rerun and the complete suite.just checkandgit diff --check: passed.--helpcommands passed. No behavior or test changes were needed for the scheduled timestamp refresh.Python 3.13, benchmarks, and live integrations were not run locally for this revision.
Checklist
!CLA: the existing CLA Assistant check passed without requesting a new signature.