Reorganize and consolidate documentation

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
2025-10-12 00:32:48 +01:00
parent d5e4795fc4
commit da30107f5b
14 changed files with 528 additions and 1430 deletions
--- a/docs/features/README.md
+++ b/docs/features/README.md
@@ -0,0 +1,179 @@
+# 🎭 Features Documentation
+
+Detailed documentation for all Storyteller RPG features.
+
+---
+
+## Feature Guides
+
+### Core Features
+
+#### [Demo Session](./DEMO_SESSION.md)
+Pre-configured test session that auto-loads on startup. Includes two characters (Bargin & Willow) and "The Cursed Tavern" adventure. Perfect for development and testing.
+
+**Quick Access:**
+- Session ID: `demo-session-001`
+- One-click buttons on home page
+- No setup required
+
+---
+
+#### [Context-Aware Response Generator](./CONTEXTUAL_RESPONSE_FEATURE.md)
+AI-powered tool for storytellers to generate responses considering multiple characters' actions simultaneously.
+
+**Key Features:**
+- Multi-character selection
+- Scene descriptions (broadcast to all)
+- Individual responses (private to each)
+- Automatic parsing and distribution
+- Smart context building
+
+---
+
+### Technical Documentation
+
+#### [Prompt Engineering Improvements](./PROMPT_IMPROVEMENTS.md)
+Details on how we improved the LLM prompts for reliable individual response parsing using the `[CharacterName]` format.
+
+**Topics Covered:**
+- Square bracket format rationale
+- Regex parsing patterns
+- System prompt enhancements
+- Edge case handling
+
+---
+
+#### [Bug Fixes Summary](./FIXES_SUMMARY.md)
+Comprehensive list of bugs fixed in the latest release.
+
+**Fixed Issues:**
+- Character chat history showing only recent messages
+- Pydantic deprecation warnings (.dict → .model_dump)
+- WebSocket manager reference errors
+- Session ID copy functionality
+
+---
+
+## Feature Overview by Category
+
+### For Storytellers 🎲
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| **Session Management** | Create/join sessions, manage characters | ✅ Complete |
+| **Scene Narration** | Broadcast scene descriptions to all players | ✅ Complete |
+| **Private Responses** | Send individual messages to characters | ✅ Complete |
+| **AI Suggestions** | Get AI-generated response suggestions | ✅ Complete |
+| **Context-Aware Generator** | Generate responses considering multiple characters | ✅ Complete |
+| **Pending Message Tracking** | See which characters need responses | ✅ Complete |
+| **Demo Session** | Pre-loaded test scenario for quick start | ✅ Complete |
+
+### For Players 🎭
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| **Character Creation** | Define name, description, personality | ✅ Complete |
+| **Private Messages** | Send private messages to storyteller | ✅ Complete |
+| **Public Actions** | Broadcast actions visible to all players | ✅ Complete |
+| **Mixed Messages** | Public action + private thoughts | ✅ Complete |
+| **Scene Viewing** | See current scene description | ✅ Complete |
+| **Public Feed** | View all players' public actions | ✅ Complete |
+| **Conversation History** | Full chat log with storyteller | ✅ Complete |
+
+### Message System 📨
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| **Private Messages** | One-on-one conversation | ✅ Complete |
+| **Public Messages** | Visible to all players | ✅ Complete |
+| **Mixed Messages** | Public + private components | ✅ Complete |
+| **Real-time Updates** | WebSocket-based live updates | ✅ Complete |
+| **Message Persistence** | In-memory storage (session lifetime) | ✅ Complete |
+
+### AI Integration 🤖
+
+| Feature | Description | Status |
+|---------|-------------|--------|
+| **Multiple LLM Support** | GPT-4o, GPT-4, GPT-3.5, Claude, Llama | ✅ Complete |
+| **AI Response Suggestions** | Quick response generation | ✅ Complete |
+| **Context-Aware Generation** | Multi-character context building | ✅ Complete |
+| **Structured Output Parsing** | [CharacterName] format parsing | ✅ Complete |
+| **Temperature Control** | Creative vs. focused responses | ✅ Complete |
+
+---
+
+## Coming Soon 🚀
+
+### Planned Features
+
+- **Database Persistence** - Save sessions and characters permanently
+- **Character Sheets** - Stats, inventory, abilities
+- **Dice Rolling** - Built-in dice mechanics
+- **Combat System** - Turn-based combat management
+- **Image Generation** - AI-generated scene/character images
+- **Voice Messages** - Audio message support
+- **Session Export** - Export conversation logs
+- **User Authentication** - Account system with saved preferences
+
+---
+
+## Feature Request Process
+
+Want to suggest a new feature?
+
+1. **Check existing documentation** - Feature might already exist
+2. **Review roadmap** - Check if it's already planned (see [MVP_ROADMAP.md](../planning/MVP_ROADMAP.md))
+3. **Create an issue** - Describe the feature and use case
+4. **Discuss implementation** - We'll evaluate feasibility and priority
+
+---
+
+## Version History
+
+### v0.2.0 - Context-Aware Features (October 2025)
+- ✅ Context-aware response generator
+- ✅ Demo session with pre-configured characters
+- ✅ Improved prompt engineering for parsing
+- ✅ Bug fixes (chat history, Pydantic warnings)
+- ✅ Session ID copy button
+
+### v0.1.0 - MVP Phase 1 (October 2025)
+- ✅ Basic session management
+- ✅ Character creation and joining
+- ✅ Private/public/mixed messaging
+- ✅ Real-time WebSocket communication
+- ✅ Scene narration
+- ✅ AI-assisted responses
+- ✅ Multiple LLM support
+
+---
+
+## Documentation Structure
+
+```
+docs/
+├── features/           ← You are here
+│   ├── README.md
+│   ├── DEMO_SESSION.md
+│   ├── CONTEXTUAL_RESPONSE_FEATURE.md
+│   ├── PROMPT_IMPROVEMENTS.md
+│   └── FIXES_SUMMARY.md
+├── development/
+│   ├── MVP_PROGRESS.md
+│   ├── TESTING_GUIDE.md
+│   └── TEST_RESULTS.md
+├── planning/
+│   ├── MVP_ROADMAP.md
+│   ├── PROJECT_PLAN.md
+│   └── NEXT_STEPS.md
+├── setup/
+│   ├── QUICKSTART.md
+│   └── QUICK_REFERENCE.md
+└── reference/
+    ├── PROJECT_FILES_REFERENCE.md
+    └── LLM_GUIDE.md
+```
+
+---
+
+**Need help?** Check the [main README](../../README.md) or the [Quick Start Guide](../setup/QUICKSTART.md).