Skip to content

docs: centralize repository knowledge and enforce upkeep in CI - #292

Merged
laipz8200 merged 6 commits into
mainfrom
docs/knowledge-review-20260910
Sep 10, 2026
Merged

laipz8200 merged 6 commits into
mainfrom
docs/knowledge-review-20260910

Conversation

@laipz8200

@laipz8200 laipz8200 commented Sep 9, 2026 •

Copy link
Copy Markdown
Member

Important

  1. Make sure you have read our contribution guidelines
  2. Search existing issues and pull requests to confirm this change is not a duplicate
  3. Open or identify the issue this pull request resolves or advances
  4. Use a Conventional Commits title for this pull request, and mark breaking changes with !
  5. Remember that the pull request title will become the squash merge commit message
  6. If CLA Assistant prompts you, sign CLA.md in the pull request conversation

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 4b95906 into a fresh worktree and continued this existing PR at c29545b. 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:

  • New checks reproduced their intended failures before implementation and received independent test reviews.
  • Latest run: uv run pytest -n 0 tests/engine/test_event_stream.py tests/test_repository_docs.py tests/test_pull_request_checks.py: 53 passed.
  • Latest run: 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 check and git diff --check: passed.
  • Independent knowledge review and final naming pass completed; both example --help commands 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

  • This pull request links the issue it resolves or advances
  • This pull request title follows Conventional Commits, and any breaking change is marked with !
  • If CLA Assistant prompted me, I signed CLA.md in the pull request conversation

CLA: the existing CLA Assistant check passed without requesting a new signature.

@laipz8200 laipz8200 added the documentation Improvements or additions to documentation label Sep 9, 2026
@laipz8200 laipz8200 changed the title docs: refresh repository knowledge after merged debt fixes docs: archive completed plans and trim active knowledge Sep 9, 2026
@laipz8200 laipz8200 changed the title docs: archive completed plans and trim active knowledge docs: define knowledge maintenance and archive completed plans Sep 9, 2026
@laipz8200 laipz8200 changed the title docs: define knowledge maintenance and archive completed plans docs: centralize repository knowledge and enforce upkeep in CI Sep 9, 2026
@laipz8200
laipz8200 enabled auto-merge (squash) September 10, 2026 09:31
@laipz8200
laipz8200 merged commit c2f8bf2 into main Sep 10, 2026
9 of 11 checks passed
@laipz8200
laipz8200 deleted the docs/knowledge-review-20260910 branch September 10, 2026 09:46
@QuantumGhost

Copy link
Copy Markdown
Contributor

Besides, how about using frontmatter to track last check time?

This might simplify the handling of last_checked, since we could rely on existing frontmatter parsers, instead of rolling our own parser.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Keep repository knowledge current and archive completed work

2 participants