docs: compact CLAUDE.md, move command intent into the justfile#239
Merged
Conversation
lesnik512
force-pushed
the
docs/compact-claude-md
branch
from
3469902 to
b6ef0d8
Compare
CLAUDE.md had drifted from the justfile (it claimed `just test` runs coverage — it doesn't; that's `just test-ci`) and duplicated roughly half of architecture/. - Commands: replace the recipe mirror with a pointer to the justfile plus the non-obvious "which to use when" notes. The justfile is now the single source of truth, self-documenting via `just --list`. - justfile: add intent doc-comments to every recipe so `just --list` carries the interpretation (coverage gate, lint-ci also validating planning). - Architecture: drop the subsections that fully duplicate architecture/*.md (scope/container detail, resolution flow, registries table); keep a tight orientation, a direct capability->file index, and the Key files map. - Reconcile the "resolution is sync-only" vs "async finalizers" wording (different axes, both true).
lesnik512
force-pushed
the
docs/compact-claude-md
branch
from
b6ef0d8 to
7c97d6a
Compare
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
1 participant
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.
Why
CLAUDE.mdhad drifted from the justfile and duplicated ~half ofarchitecture/:just testruns "coverage by default" — it doesn't. Coverage moved intojust test-ci(the--cov-fail-under=100gate CI runs). An agent trustingCLAUDE.mdas ground truth would run the wrong gate.## Architecturesection restatedscopes.md/containers.md/resolution.mdetc. — andCLAUDE.md's own preamble already declaresarchitecture/the authoritative truth home. Duplicated, rot-prone, always-on context.Principle applied: the
justfileis the truth home for commands, exactly asarchitecture/is for capabilities. Mirror neither; point to both.Changes
just --listself-documents (the coverage-gate distinction,lint-cialso validating planning bundles, etc.).architecture/*.md(scope/container detail, the 6-step resolution flow, the registries table); keep a tight orientation, a direct capability→file index, and the Key files map so agents still navigate in one cheap Read.Net:
CLAUDE.md~31 lines lighter and, more importantly, correct by construction — no recipe flags or capability prose left to rot.Verification
just --listshows the new per-recipe descriptions.just check-planning→planning: OK.uv run eof-fixer . --check→ clean.