docs: fix stale spec section references after §4/§5 renumbering#49
Merged
Conversation
The design docs gained §4.3 (lock --check) and a restructured §5, shifting apply→§4.4, status→§4.5, exit codes→§4.6, cache commands→§4.7, and parallelism/fetch/cache/locking→§5.2–§5.5. Many references still used the old numbering. This aligns everything with the current docs: - Go comments (source + tests): §4.5→§4.6 exit codes, §4.6→§4.7 cache commands, §5.3→§5.1 apply flow, §5.4→§5.2 parallelism, §5.5→§5.3 fetch strategy, §5.6→§5.4 cache/store, §5.7→§5.5 project lock; checkSync's comment now lists the fields it actually compares (subdir, symlinks) - design.zh-TW.md / design.md: §5.1 diagram cross-references (5.5→5.3), §4.1 cache row now lists `clean`, refreshed the last-updated date - requirements.md: REQ-EXIT-NET §5.5→§5.3, REQ-PARALLEL-COLLECT and REQ-JOBS-FETCHDEFAULT §5.4→§5.2 - CLAUDE.md: §4.5→§4.6, Milestone 5 status (README already has CI examples), `make test` no longer claims -v - READMEs: GRAFT_VERSION example uses a real released tag instead of v1.0.0; zh-TW README links the English design doc; normalized stray half-width punctuation in zh-TW prose Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
A doc-consistency audit across the spec, READMEs, requirements matrix, and code comments. The design docs were renumbered at some point (adding §4.3
lock --checkand restructuring §5), and many references never caught up.Spec docs (
docs/design.zh-TW.md/docs/design.md)dir/verify/prune, omittingclean(which §4.7 and Milestone 4 document).docs/requirements.mdGo comments (source + tests, no behavior change)
Old→new mapping applied per instance after verifying each context: §4.5→§4.6 (exit codes), §4.6→§4.7 (cache commands), §4.3→§4.4 (apply), §4.4→§4.5 (status), §5.3→§5.1 (apply flow/staging), §5.4→§5.2 (parallelism), §5.5→§5.3 (fetch), §5.6→§5.4 (cache/store), §5.7→§5.5 (project lock). Also fixed
checkSync's doc comment, which still said "path" (pre-rename) and omittedsymlinks/dest— it now matches the fields the code compares.CLAUDE.md
spec_test.go, which already parses §4.6).make testno longer claims-v(the Makefile doesn't pass it).READMEs
GRAFT_VERSIONpin example used the nonexistentv1.0.0; now uses the actually-releasedv0.0.1-beta.1(with a link to the releases page).,;:?) to full-width in zh-TW prose (code blocks and inline code untouched).Verification
go build ./...passes.go test -race ./internal/clierr/passes — this covers both conformance ratchets (spec_test.go§4.6 table parsing across both design docs,spec_coverage_test.goREQ-ID coverage).🤖 Generated with Claude Code