68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# 📚 Storyteller RPG - Documentation
|
|
|
|
Welcome to the Storyteller RPG documentation. All project documentation is organized here by category.
|
|
|
|
---
|
|
|
|
## 📁 Documentation Structure
|
|
|
|
### 🚀 [setup/](./setup/)
|
|
**Getting started guides and quick references**
|
|
|
|
- **[QUICKSTART.md](./setup/QUICKSTART.md)** - 5-minute quick start guide
|
|
- **[QUICK_REFERENCE.md](./setup/QUICK_REFERENCE.md)** - Quick reference for common tasks
|
|
|
|
### 📋 [planning/](./planning/)
|
|
**Product roadmaps and feature planning**
|
|
|
|
- **[MVP_ROADMAP.md](./planning/MVP_ROADMAP.md)** - MVP feature requirements and roadmap
|
|
- **[NEXT_STEPS.md](./planning/NEXT_STEPS.md)** - Detailed future development roadmap
|
|
- **[PROJECT_PLAN.md](./planning/PROJECT_PLAN.md)** - Overall project planning and goals
|
|
|
|
### 📖 [reference/](./reference/)
|
|
**Technical references and guides**
|
|
|
|
- **[LLM_GUIDE.md](./reference/LLM_GUIDE.md)** - Guide to available LLM models
|
|
- **[PROJECT_FILES_REFERENCE.md](./reference/PROJECT_FILES_REFERENCE.md)** - Complete file structure reference
|
|
|
|
### 🔧 [development/](./development/)
|
|
**Development session notes and implementation details**
|
|
|
|
- **[SESSION_SUMMARY.md](./development/SESSION_SUMMARY.md)** - Complete development session summary
|
|
- **[IMPLEMENTATION_SUMMARY.md](./development/IMPLEMENTATION_SUMMARY.md)** - Technical implementation details
|
|
|
|
---
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
**New to the project?**
|
|
1. Start with the main [README.md](../README.md) in the root directory
|
|
2. Follow [setup/QUICKSTART.md](./setup/QUICKSTART.md) to get running
|
|
3. Review [planning/MVP_ROADMAP.md](./planning/MVP_ROADMAP.md) to understand the vision
|
|
|
|
**Want to contribute?**
|
|
1. Read [development/SESSION_SUMMARY.md](./development/SESSION_SUMMARY.md) for architecture
|
|
2. Check [planning/NEXT_STEPS.md](./planning/NEXT_STEPS.md) for feature priorities
|
|
3. Refer to [reference/PROJECT_FILES_REFERENCE.md](./reference/PROJECT_FILES_REFERENCE.md) for code navigation
|
|
|
|
**Looking for specific info?**
|
|
- **Setup/Installation** → [setup/](./setup/)
|
|
- **Features & Roadmap** → [planning/](./planning/)
|
|
- **API/Models/Files** → [reference/](./reference/)
|
|
- **Architecture** → [development/](./development/)
|
|
|
|
---
|
|
|
|
## 📊 Documentation Overview
|
|
|
|
| Category | Files | Purpose |
|
|
|----------|-------|---------|
|
|
| **Setup** | 2 | Getting started and quick references |
|
|
| **Planning** | 3 | Roadmaps, feature plans, project goals |
|
|
| **Reference** | 2 | Technical guides and file references |
|
|
| **Development** | 2 | Session notes and implementation details |
|
|
|
|
---
|
|
|
|
*Last updated: October 11, 2025*
|