Split CLAUDE.md into topic files under .claude/docs/ - #6952
Merged
Conversation
CLAUDE.md grew to a single 545-line file mixing behavioral guidelines, build/run instructions, architecture, UI gotchas, and CI reference. Split it by topic into 18 files under .claude/docs/ and turn CLAUDE.md into a slim index that inlines them via @-imports in the original order, so the assembled context is byte-identical. .gitignore gets a !.claude/docs/ entry next to the existing .claude/* exceptions so the topic files are tracked. Also extend the team permission allowlist in .claude/settings.json with read-only commands observed to prompt frequently (git fetch, gh search, mvn formatter:validate). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
What
CLAUDE.mdgrew into a single 545-line file mixing behavioral guidelines, build/run instructions, architecture notes, UI gotchas, and CI reference. This splits it by topic into 18 files under.claude/docs/and turnsCLAUDE.mdinto a slim index that inlines them via@-imports in the original order — the assembled context Claude Code sees is byte-identical (verified by diffing the concatenation of the topic files againstorigin/master:CLAUDE.md)..claude/docs/—behavioral-guidelines,project-build-run,repository-layout,synchronizer-model,client-java,intent-layer,model-generation,harmonia-ui,shells,document-templates,native-apps,tenants,conventions,blimpkit,java-debugger,messaging,external-docs,ciCLAUDE.md— title + intro + one@.claude/docs/<topic>.mdline per file; the index states the editing convention (edit topic files, add new topics as file + import line).gitignore—!.claude/docs/next to the existing.claude/*exceptions, so the topic files are trackedAlso
Extends the team permission allowlist in
.claude/settings.jsonwith read-only commands that prompt frequently in practice:git fetch,gh search,mvn formatter:validate(plain and-T 1Cforms).Why
Topic files are easier to maintain and review than one monolith, and module guides can link to a specific topic instead of "see CLAUDE.md". No content was changed or reworded.
🤖 Generated with Claude Code