feat: add comprehensive project-specific CLAUDE.md documentation#146
Open
miltonvve wants to merge 2 commits into
Open
feat: add comprehensive project-specific CLAUDE.md documentation#146miltonvve wants to merge 2 commits into
miltonvve wants to merge 2 commits into
Conversation
Enhanced the generic claude.md template with detailed, project-specific documentation for Claudia development using KickAss-Claude.md-Builder principles. ## Key Improvements: ### Project-Specific Context - Detailed overview of Claudia as a Tauri-based Claude Code GUI toolkit - Complete technology stack documentation (React 18, Rust, Tauri 2, SQLite) - Architecture overview with frontend/backend separation - Target user identification and use cases ### Development Environment Setup - Platform-specific dependency installation (Linux, macOS, Windows) - Required tools and versions (Rust 1.70+, Bun, Claude Code CLI) - Step-by-step setup instructions with commands - Cross-platform compatibility considerations ### Code Organization Guidelines - Frontend development patterns (React/TypeScript best practices) - Backend development patterns (Rust modules and Tauri commands) - Inter-process communication via Tauri invoke API - State management strategies for desktop applications ### Technical Documentation - Complete project structure breakdown - Database schema and data storage locations - Integration points (Claude CLI, MCP servers, file system) - Security considerations for local desktop applications ### Development Workflow - Build and deployment processes - Testing strategies for both frontend and backend - Performance optimization guidelines - Troubleshooting common development issues ### Contribution Guidelines - Code style standards for TypeScript and Rust - Development workflow and PR requirements - Areas for community contribution - Claude Code specific development practices ## Benefits: - Significantly improved developer onboarding experience - Clear guidance for maintaining cross-platform compatibility - Comprehensive troubleshooting section for Tauri-specific issues - Enhanced code quality through documented best practices - Better integration with Claude Code development workflows ## Generated Using: - KickAss-Claude.md-Builder enhanced script - Project analysis of existing codebase and documentation - Best practices from leading AI coding assistants This replaces the generic template with actionable, project-specific guidance that will improve development efficiency and code quality. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <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
2 participants
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.
Enhanced the generic claude.md template with detailed, project-specific documentation for Claudia development using KickAss-Claude.md-Builder principles.
Key Improvements:
Project-Specific Context
Development Environment Setup
Code Organization Guidelines
Technical Documentation
Development Workflow
Contribution Guidelines
Benefits:
Generated Using:
This replaces the generic template with actionable, project-specific guidance that will improve development efficiency and code quality.