docs: add progressive-disclosure agent guidance - #349
Closed
zguesmi wants to merge 1 commit into
Closed
Conversation
`CLAUDE.md` holds only what applies to every task, plus a table pointing at five topic files under `.claude/context/`: conventions, architecture, commands, testing and upgrades. An agent reads the entry point on every task and pulls in a topic file only when the work touches it. `.claude/context/conventions.md` is new here: `CLAUDE.md` pointed at it but the file did not exist. It collects the repository invariants that were previously inline: the SPDX header pair, the published surface in `package.json#files`, the append-only storage rule, the generated files that must never be hand-edited, the two hand-maintained facet lists, and the squash-merge and Conventional Commits rules. Also ignore `.claude/worktrees`, so agent worktrees created inside the repository do not show up as untracked files now that `.claude/` is tracked. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #349 +/- ##
=======================================
Coverage 99.54% 99.54%
=======================================
Files 32 32
Lines 1095 1095
Branches 223 223
=======================================
Hits 1090 1090
Misses 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Independent of #346 / #347 / #348. Based on
main, docs only, no code touched.CLAUDE.mdis the entry point an agent reads on every task, so it holds only what applies to every task, plus a table pointing at five topic files under.claude/context/:conventions.mdarchitecture.mdcommands.mdpackage.json#scripts, reasoning about CI and generated filestesting.mdupgrades.mdThe point of the split is cost: the entry point stays small enough to load every time, and the detail is pulled in only when the work touches it.
One file was missing
CLAUDE.mdpointed at.claude/context/conventions.md, which did not exist — a dangling reference. It is written here, and collects the invariants that matter and are not derivable from the code: the SPDX header pair, the published surface inpackage.json#files(so ABI and artifact changes are public API changes), the append-only storage rule, the generated files that must never be hand-edited, the two hand-maintained facet lists inutils/proxy-tools.tsandscripts/tools/sol-to-uml.mjs, and the squash-merge / Conventional Commits rules.Also
.claude/worktreesis added to.gitignore. Now that.claude/is tracked, an agent worktree created inside the repository would otherwise show up as untracked files.Follow-up if #348 lands
.claude/context/architecture.mdnamesIexecInterfaceToken.solandIexecEscrowTokenFacet, which is correct againstmaintoday. #348 retires both names, so whichever of the two merges second needs a one-line touch-up.Verification
npm run format:check— All matched files use Prettier code style. No contract, test or script file is touched, so the build, storage, doc, typecheck and test gates are unaffected by this PR.