refactor: restructure CLAUDE.md with progressive disclosure pattern#1
Open
refactor: restructure CLAUDE.md with progressive disclosure pattern#1
Conversation
Restructured the AI assistant documentation following best practices from https://www.hlyr.dev/blog/writing-a-good-claude-md to improve effectiveness and maintainability. Key changes: - Reduced CLAUDE.md from 375 lines to 87 lines (77% reduction) - Kept only universally applicable architectural knowledge in CLAUDE.md - Created agent_docs/ directory for task-specific detailed documentation - Organized content into 6 focused documents: * component_workflows.md - Step-by-step component development * pr_testing_guide.md - PR playground usage and best practices * testing.md - Testing commands, frameworks, and strategies * naming_conventions.md - Comprehensive naming standards * common_issues.md - Troubleshooting guide * folder_structure.md - Complete directory reference Benefits: - Better signal-to-noise ratio for AI assistant - Progressive disclosure allows reading detailed docs when needed - Reduced instruction count improves overall instruction-following - More maintainable and searchable documentation - All original content preserved, just reorganized The new structure ensures Claude sees critical architectural patterns (wrapper pattern, Svelte as source of truth, design tokens first) in every conversation while keeping task-specific details available on-demand.
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.
Restructured the AI assistant documentation following best practices from
https://www.hlyr.dev/blog/writing-a-good-claude-md to improve effectiveness
and maintainability.
Key changes:
Benefits:
The new structure ensures Claude sees critical architectural patterns
(wrapper pattern, Svelte as source of truth, design tokens first) in
every conversation while keeping task-specific details available on-demand.