Condense CLAUDE.md guidance for clarity and brevity - #865
Merged
Conversation
Cut 453 lines to 304 by removing prose that duplicates JSDoc already on the code it describes: - the `skipPreamble` last-complete-wins rules and the `push()` live-root aliasing contract are documented in full on `PartialJsonStreamOptions` / `PartialJsonStream` - the three decode-usage bullets (prompt length as input count, 250ms throttle, `cached`/`cacheWrite` left undefined) are the JSDoc on `createDecodeUsageReporter` Both are now one-line rules pointing at the module. The provider run-fn conventions are reorganized as a rule list rather than a sequence of essays, and the web-console and dev-without-building sections keep their invariants without the surrounding narrative. No rule was dropped: every identifier referenced by the old file still appears, except four internals whose own JSDoc covers them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AZS3ko2CqaJY9tcWdKfakg
Coverage Report
File CoverageNo changed files found. |
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.
Streamline the CLAUDE.md documentation by removing redundancy, condensing verbose explanations, and improving readability without losing essential guidance.
Summary
This PR refactors CLAUDE.md to be more concise and scannable while preserving all critical information. The file is reorganized to prioritize the most important guidance and uses tighter language throughout.
Key changes
"bun"export condition rules into a single focused paragraph with the key constraint highlighted@workglow/utilnamed exports as a compact listuse-source/use-dist/link-alldescriptionsNotable details
→) for clearer visual flow"bun"export condition rules remain pinned to the test fixture as beforehttps://claude.ai/code/session_01AZS3ko2CqaJY9tcWdKfakg