This directory contains all project documentation for Console Jack.
- CLAUDE.md - Guidance for AI coding assistants (Claude Code)
- ARCHITECT_MODE.md - Architect mode ruleset for comprehensive design planning
- RIPER_MODE.md - RIPER-5 mode strict operational protocol
- DEVELOPER_GUIDE.md - Comprehensive development guide
- ARCHITECTURE.md - Detailed architecture documentation
- ECS_GUIDE.md - Entity Component System guide
- RENDERING_GUIDE.md - Rendering system guide
- INPUT_SYSTEM_GUIDE.md - Input system guide
- AUDIO_SYSTEM_GUIDE.md - Audio system guide
- STATE_MACHINE_GUIDE.md - State machine guide
- UI_COMPONENTS_GUIDE.md - UI component framework reference
- IMPROVEMENT_PLAN.md - Planned enhancements and technical debt
- analysis.md - Code analysis and insights
- audio/README.md - Audio assets documentation
When adding new documentation:
- Place it in this
/docsdirectory - Use descriptive filenames in lowercase with hyphens (e.g.,
user-guide.md) - Update this README.md with a brief description and link
- Keep the root-level README.md focused on quick start information only