-
Notifications
You must be signed in to change notification settings - Fork 231
Add CLAUDE.MD context file for AI development #1751
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
This file provides comprehensive project context for Claude AI sessions, including: - Project overview and tech stack - Directory structure and key files - Development workflow and testing procedures - Common tasks and code patterns - Architecture notes and deployment info This will help AI assistants better understand the project structure and provide more accurate assistance. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Greptile OverviewGreptile SummaryAdded a comprehensive
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant AI as AI Assistant (Claude Code)
participant Context as CLAUDE.MD
participant Repo as Repository Files
Dev->>AI: Request code change or question
AI->>Context: Read project overview and structure
Context-->>AI: Return tech stack, directories, key files
AI->>Context: Check relevant sections (styling/db/testing)
Context-->>AI: Return specific guidance and patterns
AI->>Repo: Navigate to relevant files using paths from context
Repo-->>AI: Return file contents
AI->>AI: Apply project conventions from context
AI->>Dev: Provide accurate suggestion following project patterns
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 4 comments
CLAUDE.MD
Outdated
| reflex-web/ | ||
| ├── pcweb/ # Main Reflex application | ||
| │ ├── pages/ # Page components (landing, docs, blog, pricing, etc.) | ||
| │ ├── components/ # Reusable UI components (22 subdirectories) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doc says 22 subdirectories but pcweb/components/ only has 4 subdirectories
| │ ├── components/ # Reusable UI components (22 subdirectories) | |
| │ ├── components/ # Reusable UI components (4 subdirectories) |
CLAUDE.MD
Outdated
| │ ├── enterprise/ # Enterprise features (AG Grid, Mantine, React Flow) | ||
| │ └── api-reference/ # API documentation | ||
| │ | ||
| ├── blog/ # Blog posts (29+ markdown files) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doc says 29+ markdown files but blog/ directory has 27 markdown files
| ├── blog/ # Blog posts (29+ markdown files) | |
| ├── blog/ # Blog posts (27 markdown files) |
CLAUDE.MD
Outdated
| 7. **Enterprise** - AG Grid, Mantine, React Flow integration | ||
| 8. **API Reference** - Complete API documentation | ||
|
|
||
| Blog posts (29+) cover technical topics and framework updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doc says 29+ blog posts but there are 27 markdown files in the blog/ directory
| Blog posts (29+) cover technical topics and framework updates. | |
| Blog posts (27) cover technical topics and framework updates. |
CLAUDE.MD
Outdated
|
|
||
| Current branch: `focused-euler` | ||
| Main branch: `main` | ||
| This is a git worktree (check git status for current location and main repository path) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hard-coding branch name will quickly become outdated - consider removing or making this dynamic
- Remove extensive documentation and architecture details - Keep only: running the app, testing commands, and PR guidelines - Make it more concise and practical for contributors Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Summary
Adds a comprehensive CLAUDE.MD file that provides project context for AI development assistants, particularly Claude Code.
What's Included
Why This Helps
This file will help AI assistants:
Test Plan
🤖 Generated with Claude Code