Create or update CLAUDE.md documentation #16
Merged
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
Completely revamp CLAUDE.md to provide AI assistants with detailed codebase understanding: Added Sections: - Project Overview with version and tech stack - Detailed project structure tree with file descriptions - Comprehensive test suite organization and markers guide - Docker and Kubernetes deployment documentation - Dependencies breakdown (production and dev) - Architecture & Key Decisions section covering: - Evolution timeline (v1.0.x → v1.2.x) - StateManager architecture and migration patterns - View synchronization strategy evolution - Game logic patterns and win conditions - UI/UX design decisions and color schemes - Testing strategy evolution and test pyramid - File organization principles - Known issues and gotchas - Performance considerations - Quick Reference Cheat Sheet with: - Most common commands - Project locations map - Common tasks and solutions - Key concepts to remember - Troubleshooting guide - Version history highlights - Resource links Enhanced Sections: - Build Commands with test category examples - Test Suite Organization with 165+ test breakdown - CI Test Execution with exclusion rationale - Writing New Tests with marker examples - Test Coverage Goals with specific targets - StateManager usage consolidated into quick reference Documentation now provides: - Clear entry points (app.py vs main.py) - Understanding of modular vs legacy architecture - State persistence migration guide - Timer-based sync vs deprecated ui.broadcast() - Test marker system for selective execution - CI optimization strategy (139 tests in ~7s) - Docker and Helm deployment workflows - Complete troubleshooting scenarios This comprehensive update enables AI assistants to: - Understand project evolution and architectural decisions - Navigate codebase effectively with file location guide - Write tests with appropriate markers - Debug common issues with troubleshooting guide - Follow established patterns and conventions - Deploy using Docker/Kubernetes References version 1.2.1 state as of 2025-11-15.
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.
Completely revamp CLAUDE.md to provide AI assistants with detailed codebase understanding:
Added Sections:
Enhanced Sections:
Documentation now provides:
This comprehensive update enables AI assistants to:
References version 1.2.1 state as of 2025-11-15.