da30107f5b
Documentation Structure: - Created docs/features/ for all feature documentation - Moved CONTEXTUAL_RESPONSE_FEATURE.md, DEMO_SESSION.md, FIXES_SUMMARY.md, PROMPT_IMPROVEMENTS.md to docs/features/ - Moved TESTING_GUIDE.md and TEST_RESULTS.md to docs/development/ - Created comprehensive docs/features/README.md with feature catalog Cleanup: - Removed outdated CURRENT_STATUS.md and SESSION_SUMMARY.md - Removed duplicate files in docs/development/ - Consolidated scattered documentation Main README Updates: - Reorganized key features into categories (Core, AI, Technical) - Added Demo Session section with quick-access info - Updated Quick Start section with bash start.sh instructions - Added direct links to feature documentation Documentation Hub Updates: - Updated docs/README.md with new structure - Added features section at top - Added current status (v0.2.0) - Added documentation map visualization - Better quick links for different user types New Files: - CHANGELOG.md - Version history following Keep a Changelog format - docs/features/README.md - Complete feature catalog and index Result: Clean, organized documentation structure with clear navigation
154 lines
5.1 KiB
Markdown
154 lines
5.1 KiB
Markdown
# 📚 Storyteller RPG Documentation
|
|
|
|
Welcome to the Storyteller RPG documentation hub. All project documentation is organized here for easy navigation.
|
|
|
|
---
|
|
|
|
## 📂 Documentation Structure
|
|
|
|
### ✨ [Features](./features/)
|
|
|
|
Comprehensive feature documentation with examples and guides.
|
|
|
|
- **[Features Overview](./features/README.md)** - Complete feature catalog
|
|
- **[Demo Session Guide](./features/DEMO_SESSION.md)** - Using the pre-configured test session
|
|
- **[Context-Aware Responses](./features/CONTEXTUAL_RESPONSE_FEATURE.md)** - Multi-character AI generation
|
|
- **[Prompt Engineering](./features/PROMPT_IMPROVEMENTS.md)** - LLM prompt techniques
|
|
- **[Bug Fixes](./features/FIXES_SUMMARY.md)** - Recent fixes and improvements
|
|
|
|
### 🚀 [Setup Guides](./setup/)
|
|
|
|
Get started quickly with installation and configuration guides.
|
|
|
|
- **[Quickstart Guide](./setup/QUICKSTART.md)** - Step-by-step setup instructions
|
|
- **[Quick Reference](./setup/QUICK_REFERENCE.md)** - Common commands and workflows
|
|
|
|
### 📋 [Planning & Roadmap](./planning/)
|
|
|
|
Project vision, milestones, and future plans.
|
|
|
|
- **[Project Plan](./planning/PROJECT_PLAN.md)** - Overall project structure and goals
|
|
- **[MVP Roadmap](./planning/MVP_ROADMAP.md)** - Minimum viable product phases
|
|
- **[Next Steps](./planning/NEXT_STEPS.md)** - Immediate priorities and tasks
|
|
|
|
### 🔧 [Development](./development/)
|
|
|
|
Technical implementation details and testing.
|
|
|
|
- **[MVP Progress](./development/MVP_PROGRESS.md)** - Current status and achievements
|
|
- **[Testing Guide](./development/TESTING_GUIDE.md)** - How to test the application
|
|
- **[Test Results](./development/TEST_RESULTS.md)** - Latest test results
|
|
|
|
### 📖 [Reference](./reference/)
|
|
|
|
Technical guides and comprehensive references.
|
|
|
|
- **[LLM Guide](./reference/LLM_GUIDE.md)** - Working with different AI models
|
|
- **[Project Files Reference](./reference/PROJECT_FILES_REFERENCE.md)** - Complete file structure
|
|
|
|
---
|
|
|
|
## 🔗 Quick Links
|
|
|
|
### For New Users
|
|
1. ⚡ Start with [Quickstart Guide](./setup/QUICKSTART.md)
|
|
2. 🎮 Try the [Demo Session](./features/DEMO_SESSION.md) (pre-configured!)
|
|
3. 📖 Review [Features Overview](./features/README.md) to see what's possible
|
|
4. 🤖 Check [LLM Guide](./reference/LLM_GUIDE.md) for model selection
|
|
|
|
### For Developers
|
|
1. 🔧 Read [MVP Progress](./development/MVP_PROGRESS.md) for current state
|
|
2. 🧪 Check [Testing Guide](./development/TESTING_GUIDE.md)
|
|
3. 📁 Review [Project Files Reference](./reference/PROJECT_FILES_REFERENCE.md)
|
|
4. 🚀 Follow [Next Steps](./planning/NEXT_STEPS.md) for contribution areas
|
|
|
|
### For Storytellers
|
|
1. 🎭 See [Features Guide](./features/README.md) for all tools
|
|
2. 🧠 Learn about [Context-Aware Responses](./features/CONTEXTUAL_RESPONSE_FEATURE.md)
|
|
3. 💡 Use [Quick Reference](./setup/QUICK_REFERENCE.md) for common tasks
|
|
4. 🎲 Start with [Demo Session](./features/DEMO_SESSION.md) for practice
|
|
|
|
---
|
|
|
|
## 📊 Current Status (v0.2.0)
|
|
|
|
### ✅ Completed Features
|
|
- Private/public/mixed messaging system
|
|
- Context-aware AI response generator
|
|
- Demo session with pre-configured characters
|
|
- Real-time WebSocket communication
|
|
- Multi-LLM support (GPT-4o, Claude, Llama, etc.)
|
|
- AI-assisted storyteller suggestions
|
|
- Session ID quick copy
|
|
- Full conversation history
|
|
|
|
### 🚧 Coming Soon
|
|
- Database persistence
|
|
- Character sheets & stats
|
|
- Dice rolling mechanics
|
|
- Combat system
|
|
- Image generation
|
|
- Voice messages
|
|
|
|
See [MVP Roadmap](./planning/MVP_ROADMAP.md) for the complete timeline.
|
|
|
|
---
|
|
|
|
## 📝 Documentation Principles
|
|
|
|
This documentation follows these principles:
|
|
|
|
- **Progressive Disclosure**: Start simple, dive deeper as needed
|
|
- **Always Current**: Updated with each feature implementation
|
|
- **Example-Driven**: Real code examples and use cases
|
|
- **Clear Structure**: Logical organization for easy navigation
|
|
- **Feature-Focused**: Detailed guides for every feature
|
|
|
|
---
|
|
|
|
## 🎯 Documentation Map
|
|
|
|
```
|
|
docs/
|
|
├── features/ ← Feature guides & examples
|
|
│ ├── README.md
|
|
│ ├── DEMO_SESSION.md
|
|
│ ├── CONTEXTUAL_RESPONSE_FEATURE.md
|
|
│ ├── PROMPT_IMPROVEMENTS.md
|
|
│ └── FIXES_SUMMARY.md
|
|
├── setup/ ← Installation & quick start
|
|
│ ├── QUICKSTART.md
|
|
│ └── QUICK_REFERENCE.md
|
|
├── planning/ ← Roadmap & future plans
|
|
│ ├── PROJECT_PLAN.md
|
|
│ ├── MVP_ROADMAP.md
|
|
│ └── NEXT_STEPS.md
|
|
├── development/ ← Technical & testing docs
|
|
│ ├── MVP_PROGRESS.md
|
|
│ ├── TESTING_GUIDE.md
|
|
│ └── TEST_RESULTS.md
|
|
└── reference/ ← Technical references
|
|
├── LLM_GUIDE.md
|
|
└── PROJECT_FILES_REFERENCE.md
|
|
```
|
|
|
|
---
|
|
|
|
## 🤝 Contributing to Documentation
|
|
|
|
Found a typo or want to improve the docs? Contributions are welcome!
|
|
|
|
1. Documentation lives in the `docs/` folder
|
|
2. Use clear, concise language
|
|
3. Include examples where helpful
|
|
4. Keep formatting consistent
|
|
5. Update relevant indexes when adding new docs
|
|
|
|
---
|
|
|
|
**Need help?** Start with the [Quickstart Guide](./setup/QUICKSTART.md) or check the main [README](../README.md).
|
|
|
|
---
|
|
|
|
*Last updated: October 11, 2025*
|