training-academy/docs/DOCS_SITE_STRUCTURE.md

Documentation Site Structure

Recommended Site Organization

1. Getting Started 📚

Welcome users and help them set up the game.

Files:

• getting-started/overview.md (from README.md)
• getting-started/installation.md (from README-DESKTOP.md)
• getting-started/quick-start.md (new - basic first-time setup)
• getting-started/changelog.md (from VERSION_0.51_CHANGELOG.md)

---

2. Game Modes 🎮

Documentation for each playable mode.

Files:

• game-modes/index.md (overview of all modes)
• game-modes/campaign.md (campaign mode guide)
• game-modes/training-academy.md (training modules overview)
• game-modes/quick-play.md (quick play features)
• game-modes/library.md (library/hypno gallery)

Campaign Sub-section:

• game-modes/campaign/overview.md (from training-game-redesign/OVERVIEW.md)
• game-modes/campaign/structure.md (from training-game-redesign/CAMPAIGN-STRUCTURE.md)
• game-modes/campaign/levels-1-15.md (from LEVELS_1-15_BREAKDOWN.md)
• game-modes/campaign/levels-16-20.md (from LEVELS_16-20_BREAKDOWN.md)
• game-modes/campaign/phase-implementation.md (combining all PHASE-X.md files)

Training Academy Sub-section:

• game-modes/training-academy/modules.md (from TRAINING_MODULES.md)
• game-modes/training-academy/rank-system.md (from MODULE_RANK_SYSTEM.md)

---

3. Features ✨

Detailed feature documentation.

Files:

• features/caption-library.md (from CAPTION_LIBRARY.md)
• features/media-tagging.md (from TAGGING_IMPLEMENTATION_SUMMARY.md)
• features/position-verification.md (from position-verification-library.md)
• features/consequences.md (from consequences.md)
• features/rhythm-timeline.md (from rhythm-timeline/)

---

4. Guides 📖

How-to guides for specific tasks.

Files:

• guides/library-setup.md (setting up media library)
• guides/tagging-guide.md (how to tag your media)
• guides/customization.md (preferences, settings, themes)
• guides/troubleshooting.md (common issues and fixes)

---

5. Development 🛠️

For developers and contributors.

Files:

• development/roadmap.md (from ROADMAP.md)
• development/contributing.md (new - how to contribute)
• development/architecture.md (technical overview)
• development/changelog.md (version history)
• development/bugfixes.md (from VERSION_0.51_BUGFIXES.md)

---

6. Reference 📋

Quick reference materials.

Files:

• reference/level-structure.md (from LEVEL_STRUCTURE_TEMPLATE.md)
• reference/task-types.md (comprehensive task type reference)
• reference/game-stats.md (from GAME_STATS_PANEL_FIX.md)
• reference/api.md (if exposing any APIs)

---

Suggested Navigation Structure

Home
├── Getting Started
│   ├── Overview
│   ├── Installation
│   ├── Quick Start
│   └── Changelog
│
├── Game Modes
│   ├── Overview
│   ├── Campaign Mode
│   │   ├── Overview
│   │   ├── Structure
│   │   ├── Levels 1-15
│   │   ├── Levels 16-20
│   │   └── Implementation Phases
│   │
│   ├── Training Academy
│   │   ├── Training Modules
│   │   └── Rank System
│   │
│   ├── Quick Play
│   └── Media Library
│
├── Features
│   ├── Caption Library
│   ├── Media Tagging
│   ├── Position Verification
│   ├── Consequences System
│   └── Rhythm Timeline
│
├── Guides
│   ├── Library Setup
│   ├── Tagging Your Media
│   ├── Customization
│   └── Troubleshooting
│
├── Development
│   ├── Roadmap
│   ├── Contributing
│   ├── Architecture
│   └── Changelog
│
└── Reference
    ├── Level Structure
    ├── Task Types
    └── Game Stats

---

Files to Archive (Keep in /archive)

These are historical/internal docs not needed for users:

• ACADEMY_PHASE1_COMPLETE.md
• DISTRIBUTION_SUMMARY.md
• TAGGING_COMPLETE.md
• tasks.md
• All files already in archive/

---

Next Steps

1. Choose a documentation platform:

   • VitePress (Vue-based, modern, fast)
   • Docusaurus (React-based, feature-rich)
   • MkDocs (Python-based, simple)
   • Docsify (No build step, lightweight)
   • GitBook (Hosted option)

2. Reorganize files into new structure

3. Create index/overview pages

4. Add navigation config

5. Style with your game's branding (purple/pink theme)

---

Recommended Platform: VitePress

Why?

• Modern, fast, and beautiful
• Markdown-based
• Vue components if needed
• Easy theming
• Built-in search
• Mobile responsive
• Low maintenance

Quick Setup:

npm install -D vitepress
mkdir docs-site
cd docs-site
npx vitepress init

Then migrate your organized docs into the structure above.