Add comprehensive CLAUDE.md documentation for AI assistants#14
Add comprehensive CLAUDE.md documentation for AI assistants#14epavanello merged 2 commits intomainfrom
Conversation
Created a detailed guide for AI assistants working with the DevMotion codebase, including: - Complete project overview and technology stack - Detailed architecture and design patterns - Comprehensive directory structure with explanations - Development workflows and commands - Code conventions and style guide - Key concepts (Project, Layers, Keyframes, Animation Engine, MCP Server) - Testing guidelines and examples - Common tasks and troubleshooting guide - Best practices for state management, performance, and security This documentation will help AI assistants understand the codebase structure, follow project conventions, and implement changes more effectively. https://claude.ai/code/session_01MXufG9kCKY5NJMyaaEU3dj
Reduced from 1000+ to ~200 lines by removing redundant code examples and focusing on essential patterns AI assistants need to follow: - Core architecture patterns (Svelte 5 runes, Zod-first, shared mutations) - Key file locations for quick reference - Essential conventions and DO/DON'T guidelines - Common tasks with minimal examples - Quick command reference The goal is to provide actionable tips without duplicating the codebase. https://claude.ai/code/session_01MXufG9kCKY5NJMyaaEU3dj
📝 WalkthroughWalkthroughA new comprehensive documentation file, CLAUDE.md, has been added to guide AI assistant development within the DevMotion editor ecosystem. The document covers architecture patterns, key file locations, conventions, core data types, common tasks, development workflows, and critical patterns to follow. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CLAUDE.md`:
- Around line 67-76: The fenced code block containing the src/lib/ directory
tree is missing a language specifier (triggers MD040); update the opening fence
(```) to include a language such as text so it becomes ```text — this change
should be made where the directory tree block (starting with "src/lib/") is
declared in CLAUDE.md to satisfy the linter.
| ``` | ||
| src/lib/ | ||
| ├── stores/ # Global state (Svelte 5 runes) | ||
| ├── schemas/ # Zod schemas (source of truth for types) | ||
| ├── engine/ # Animation interpolation & rendering | ||
| ├── layers/ # Layer type components & registry | ||
| ├── ai/ # Shared mutation logic for web + MCP | ||
| ├── components/ # UI components (editor/, ui/, ai/) | ||
| └── server/ # Server-only code (db/, services/) | ||
| ``` |
There was a problem hiding this comment.
Add a language specifier to the fenced code block.
Line 67 opens a fenced block without a language, which trips MD040. Consider using text for the directory tree.
🛠️ Suggested fix
-```
+```text
src/lib/
├── stores/ # Global state (Svelte 5 runes)
├── schemas/ # Zod schemas (source of truth for types)
├── engine/ # Animation interpolation & rendering
├── layers/ # Layer type components & registry
├── ai/ # Shared mutation logic for web + MCP
├── components/ # UI components (editor/, ui/, ai/)
└── server/ # Server-only code (db/, services/)</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.20.0)</summary>
[warning] 67-67: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In @CLAUDE.md around lines 67 - 76, The fenced code block containing the
src/lib/ directory tree is missing a language specifier (triggers MD040); update
the opening fence () to include a language such as text so it becomes text
— this change should be made where the directory tree block (starting with
"src/lib/") is declared in CLAUDE.md to satisfy the linter.
</details>
<!-- fingerprinting:phantom:triton:eagle -->
<!-- This is an auto-generated comment by CodeRabbit -->
Created a detailed guide for AI assistants working with the DevMotion codebase, including:
This documentation will help AI assistants understand the codebase structure,
follow project conventions, and implement changes more effectively.
https://claude.ai/code/session_01MXufG9kCKY5NJMyaaEU3dj
Summary by CodeRabbit