Welcome to the Director's Palette documentation. This directory contains all technical documentation for developers and contributors.
- Architecture - System design and technical architecture
- Troubleshooting - Common issues and solutions
- Changelog - Version history and migration guides
- FIXES-COMPLETE.md - Recent bug fixes and solutions
- Start with Architecture to understand the system
- Check Troubleshooting for common issues
- Review CLAUDE.md for AI-assisted development
- Reference extraction and configuration
- Shot generation with director styles
- Visual themes and treatments
- See: Troubleshooting #2
- Chapter detection and breakdown
- Character/location references
- Director style application
- See: Architecture - Mode-Specific
- Zustand stores organization
- Workflow coordination
- Session persistence
- See: Architecture - State Management
- Server action errors
- Schema validation
- API failures
- See: Troubleshooting
- Use UPPERCASE for main docs (README.md, CHANGELOG.md)
- Use kebab-case for guides (setup-guide.md)
- Keep related docs in subdirectories
- Clear heading hierarchy
- Code examples with syntax highlighting
- Problem → Solution format for troubleshooting
- Version numbers and dates in changelog
- Update CHANGELOG.md with each release
- Add new issues to TROUBLESHOOTING.md
- Keep architecture docs in sync with code
- Archive outdated docs in
archive/folder
- Follow existing format and style
- Include code examples
- Add cross-references
- Update index when adding new docs
- Test all code snippets
- Check documentation first
- Search GitHub issues
- Ask in discussions
- Contact maintainers
Last updated: 2024-08-12