docs: add modular .claude.md files for each source directory #2
Conversation
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
- Improve main CLAUDE.md with philosophy section, test/typecheck commands, and descriptions in thread properties table - Add src/.claude.md with module structure overview - Add src/commands/.claude.md with command pattern and available commands - Add src/models/.claude.md with type definitions and design notes - Add src/storage/.claude.md with CRUD functions and backup behavior - Add src/utils/.claude.md with color conventions and tree rendering
There was a problem hiding this comment.
Pull request overview
This PR adds modular .claude.md documentation files to provide structured guidance for Claude Code when working with the codebase. The main CLAUDE.md is enhanced with additional context, and new documentation files are created for each source directory to explain their purpose and structure.
Changes:
- Enhanced main
CLAUDE.mdwith philosophy section, test/typecheck commands, and expanded thread properties table - Added directory-level
.claude.mdfiles forsrc/,src/commands/,src/models/,src/storage/, andsrc/utils/ - Each subdirectory documentation includes module purpose, key functions/types, usage patterns, and design notes
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
CLAUDE.md |
Added philosophy section, test/typecheck commands, descriptions column in thread properties table, and note about automatic backups |
src/.claude.md |
Documents module structure, entry point, import conventions, and guidelines for adding new modules |
src/commands/.claude.md |
Describes command pattern, lists all available commands with aliases, explains thread resolution pattern and output conventions |
src/models/.claude.md |
Documents TypeScript types including Thread interface, enums, supporting types, and design notes about IDs and timestamps |
src/storage/.claude.md |
Details data persistence layer including file locations, CRUD functions, and design patterns (no caching, automatic backup) |
src/utils/.claude.md |
Explains formatting functions, color conventions for status/temperature, tree view rendering, and TreeNode structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
and descriptions in thread properties table