Repository navigation
docs(agents): keep design records, index/check/archive them with tools/doc-tools - #4
Merged
Merged
Conversation
…e them with tools/doc-tools - .agents/docs/: records are append-only. Past years' records that are not active move to archive/<YYYY>/; README.md is generated from the records. Records dated 2026-11-08 or later declare subject and status in front matter; the 20 older ones are indexed by date and title, not rewritten. - .agents/plan/ is merged into .agents/docs/ (moved with move_record.py, which rewrote the reference in the mingw sysroot record); .agents/ holds only docs/ and skills/. - consolidated-design: the commit holding the deleted documents is not in this repository; link it in the old repository ZheFeng7110/boost-module. - tools/doc-tools/: records.py (shared), gen_index.py, check_docs.py, move_record.py, archive_records.py and their tests; standard library only, path- and line-ending-safe on Windows. - .github/workflows/docs.yml: runs the tests and check_docs.py on Linux, separately from verify-scripts.yml. - Design record: 2026-11-08-design-records-management-design.md.
… is preferred, not required, for tools/doc-tools - .github/workflows/docs.yml -> check-docs.yml, including its own path filter. - The design record, the workflow comment and records.py state that a third-party package is allowed when declared in tools/pyproject.toml.
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.
Summary
.agents/docs/are append-only: no more deleting old records in favour of a summary. Past years' records that are notactivemove to.agents/docs/archive/<YYYY>/;.agents/docs/README.mdis generated from the records.subject/status(andsuperseded_bywhen superseded) in front matter. The 20 older records are not rewritten; they are indexed by date and title and exempt from the checks..agents/plan/is merged into.agents/docs/(moved with the newmove_record.py, which rewrote the reference in2026-09-19-mingw-sysroot-bootstrap.md)..agents/now holds onlydocs/andskills/.2026-09-08-consolidated-design.md: the commit03f6161holding the deleted documents does not exist in this repository (history starts 2026-10-26); link it in the old repositoryZheFeng7110/boost-module.tools/doc-tools/:records.py(shared),gen_index.py(--check),check_docs.py(layout, naming, front matter, index freshness, links, user docs do not cite.agents/),move_record.py,archive_records.py, plus unit tests. Standard library preferred (third-party packages go intools/pyproject.toml); paths and line endings are Windows-safe..github/workflows/check-docs.yml(Linux, Python 3.11), separate fromverify-scripts.yml; triggers only on.agents/**,docs/**,README*.md,tools/doc-tools/**..agents/docs/2026-11-08-design-records-management-design.md.Test plan
python3 -m unittest discover -s tools/doc-tools/tests(13 tests)python3 tools/doc-tools/check_docs.pypython3 tools/doc-tools/archive_records.py --dry-run --today 2027-01-02lists the 2026 recordsCheck Documentsgreen (Python 3.11)