Skip to content

docs: fix stale spec section references after §4/§5 renumbering#49

Merged
min0625 merged 2 commits into
mainfrom
docs/fix-stale-spec-refs
Jul 3, 2026
Merged

docs: fix stale spec section references after §4/§5 renumbering#49
min0625 merged 2 commits into
mainfrom
docs/fix-stale-spec-refs

Conversation

@min0625

@min0625 min0625 commented Jul 3, 2026

Copy link
Copy Markdown
Owner

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 --check and restructuring §5), and many references never caught up.

Spec docs (docs/design.zh-TW.md / docs/design.md)

  • §5.1 apply-flow diagram pointed at "5.5" for the fetch fallback and sparse checkout — the fetch strategy is §5.3 (both languages).
  • §4.1 command table listed cache subcommands as dir/verify/prune, omitting clean (which §4.7 and Milestone 4 document).
  • Refreshed the stale "last updated" header (was 2026-06-13 despite later edits).

docs/requirements.md

  • REQ-EXIT-NET pointed at §5.5 (locking) instead of §5.3 (fetch strategy); REQ-PARALLEL-COLLECT and REQ-JOBS-FETCHDEFAULT pointed at §5.4 (cache) instead of §5.2 (parallelism).

Go 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 omitted symlinks/dest — it now matches the fields the code compares.

CLAUDE.md

  • §4.5→§4.6 for the exit-code table (matching spec_test.go, which already parses §4.6).
  • Milestone 5 status: the README already ships CI usage examples (GitHub Actions, GitLab CI) and a comparison section — it was described as "marked as planned".
  • make test no longer claims -v (the Makefile doesn't pass it).

READMEs

  • GRAFT_VERSION pin example used the nonexistent v1.0.0; now uses the actually-released v0.0.1-beta.1 (with a link to the releases page).
  • zh-TW README now also links the English design doc, matching the English README.
  • Normalized stray half-width punctuation (, ; : ?) 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.go REQ-ID coverage).

🤖 Generated with Claude Code

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-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@codecov

codecov Bot commented Jul 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@min0625 min0625 merged commit 5131903 into main Jul 3, 2026
9 checks passed
@min0625 min0625 deleted the docs/fix-stale-spec-refs branch July 3, 2026 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant