Repository navigation
Conversation
- docs-kit.json loader (JSON with comments) - check: layout rule, doc maps, snapshots, how-tos, print copies; every scanning check fails on an empty set (H10) - move: file-by-file git mv, relative link and repo-root path rewriting, protected and immutable guards, pieced-path review list, ignored-file visibility check, git status report - fixture repo reproducing H1-H10 with one test per guard - examples: docs-kit.json, vitest and pytest wrappers Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- roles list in docs-kit.json; roles: in each how-to's front matter - docs-kit index writes the "How-tos by role" section of docs/README.md - check fails on missing or unknown roles, and on a missing or out-of-date section; no how-tos with roles configured fails (H10) - pieced-path review names a moved folder once Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Rollout step 0.1 (DESIGN §10): the layout rule,
docs-kit.json,check(including how-tos by role, §4.1),index,move, and a test for every hazard guard.What is in it
docs-kit check: root entries, subject READMEs, noexports/tree, doc maps, snapshot folders and freshness (by file name), how-to staleness, print copies, archive shape, and how-tos by role. Every check that scans a set fails when the set is empty (H10).--json,--today.docs-kit index: writes the "How-tos by role" section ofdocs/README.mdfrom each how-to'sroles:front matter.checkfails when it is missing or out of date.docs-kit move: moves file by file withgit mv, rewrites relative Markdown links and repo-root path strings (including.gitignore, scripts, workflows), refuses protected and immutable paths, lists pieced-together paths for review, checks that moved ignored files stay ignored, ends withgit status --porcelainand the layout check.--dry-run.example-app) that reproduces H1 to H10, with a test per guard intest/hazards.test.mjs. Each guard was also broken on purpose to confirm its test then fails.docs-kit.json, and the check wrapped as a vitest and a pytest test.Decisions recorded
roles, and the section is generated bydocs-kit indexand verified bycheck.snapshotStaleDays(default 30) added to the config keys in §5.Notes for review
snapshots/<topic>/folder may hold only dated snapshots).docs-kit printis reserved and exits 2 until 0.2.\-style paths; no chained moves in one call).Test
npm test(Node 22+, git; no dependencies).🤖 Generated with Claude Code