Adastrea Documentation Index
March 8, 2026 ยท View on GitHub
Last Updated: March 8, 2026 Version: 2.4 - Endless Development Cycle Purpose: Comprehensive index of all documentation in the Adastrea project
๐ Latest Update: Endless Development Cycle (March 8, 2026)
What's New:
- ๐ Endless development - Hourly commits for continuous improvement
- ๐ Code quality fixes - Docking settings duplicate code resolved
- ๐ Documentation updates - TODO management standards established
- ๐ฏ Active maintenance - Regular commits to maintain GitHub activity
- ๐ System monitoring - Automated health checks and quality assurance
Systems Archived:
- Exploration & Discovery (2 files)
- Sector & Map Systems (12 files)
- Progression & Player Systems (5 files)
- Advanced Ship Systems (3 files)
- Advanced UI Systems (4 files)
- Guild/Way Network Systems (4 files)
- Settings & Data Management (9 files)
- Visual Effects & Polish (4 files)
- AI Designer Workflows (1 file)
- Pre-Pivot Master Documentation (1 file)
For Archive Details: See Pre-MVP Systems Archive โญ NEW
๐ Previous Update: Blueprint Learning Materials (January 17, 2026)
What's New:
- ๐ Complete Learning Path - Structured progression from beginner to mastery
- ๐ Blueprint Fundamentals Guide - Zero-to-hero Blueprint tutorial (20,000+ chars)
- ๐ง Node Reference Guide - Every Blueprint node type explained (15,000+ chars)
- ๐ฏ Patterns Library - 15 reusable Blueprint patterns (14,000+ chars)
- ๐ Troubleshooting Guide - Common problems and solutions (16,000+ chars)
Key Features:
- 4-Level Learning Path: Beginner (0-2h) โ MVP (2-6h) โ Advanced (6-12h) โ Mastery
- Hands-on Exercises: 3 practice Blueprints with step-by-step instructions
- Real Examples: All patterns from actual Adastrea project
- Visual Diagrams: SVG images showing Blueprint node connections
- Progressive Learning: Build skills incrementally with clear milestones
For Beginners: Start with Blueprint Fundamentals โญ For All Developers: See Learning Path โญ
๐ Major Update: Documentation Reorganization (December 24, 2025)
What Changed:
- ๐๏ธ Removed 80+ obsolete files (reviews, summaries, duplicates)
- ๐ Organized into docs/ - Structured folders for easy navigation
- ๐ 93% reduction in root directory files (172 โ 11)
- โจ Clean structure - No more scattered documentation
Key Changes:
- All documentation moved to organized
docs/folders - Root directory now contains only 11 essential files
- Better navigation with clear categories
- Consolidated duplicate guides into comprehensive documents
Quick Navigation
๐ Start Here
- docs/README.md - โญ Complete navigation guide for organized documentation
- MASTER_DOCUMENTATION.md - Complete documentation in one comprehensive file
- README.md - Project overview and quick start
- CURRENT_STATUS.md - Realistic project status (code 85%, content 10%)
๐ฏ By Role
Learning Blueprints:
- Complete Beginner? โ docs/learning/BLUEPRINT_FUNDAMENTALS.md โญ NEW - START HERE!
- Learning Path โ docs/learning/README.md โญ NEW
- Blueprint Problem? โ docs/learning/BLUEPRINT_TROUBLESHOOTING.md โญ NEW
Other Roles:
- New Developer? โ docs/setup/SETUP_CHECKLIST.md
- Content Designer? โ Assets/DesignerOnboarding.md
- Need Quick Answer? โ docs/reference/CHEATSHEET.md
- Working on Blueprints? โ Blueprints/README.md
- Creating Blueprint Guide? โ docs/reference/BLUEPRINT_GUIDE_TEMPLATE.md
๐ By Category
- Essential Files (Root)
- docs/learning/ โญ NEW
- docs/systems/
- docs/development/
- docs/setup/
- docs/testing/
- docs/content-generation/
- docs/reference/
- Assets/
- Plugins/
- wiki/
Essential Files (Root Directory)
10 files - Core project documentation that should remain easily accessible:
| File | Purpose | Lines |
|---|---|---|
| README.md | Project overview, features, quick start | 841 |
| ARCHITECTURE.md | System architecture and design patterns | 800+ |
| CODE_STYLE.md | C++ and Blueprint coding standards | 600+ |
| CONTRIBUTING.md | Contribution guidelines and workflow | 500+ |
| ROADMAP.md | Main development roadmap and vision | 1304 |
| CHANGELOG.md | Version history and release notes | - |
| QUICKSTART.md | Fast project setup guide | - |
| GETTING_STARTED.md | โญ Modern MVP-focused entry point | - |
| MIGRATION_GUIDE.md | Repository migration guide (January 2026) | - |
| DOCUMENTATION_INDEX.md | This file - complete documentation index | 722 |
| OBSOLETE_DOCUMENTS.md | Tracking removed/obsolete files | - |
Archived (moved to docs/archive/pre-mvp-systems/):
MASTER_DOCUMENTATION.md- Pre-pivot comprehensive guide (December 9, 2025)CURRENT_STATUS.md- Historical snapshot (moved to critical review archive)
docs/learning/ - Blueprint Learning Materials โญ NEW
5 comprehensive guides - Complete Blueprint learning path for beginners:
Core Learning Guides
| File | Purpose | Characters |
|---|---|---|
| README.md | โญ START HERE - Complete learning path with 4 progressive levels | 11,000+ |
| BLUEPRINT_FUNDAMENTALS.md | Complete beginner's guide to Blueprints - your first steps | 20,000+ |
| BLUEPRINT_NODE_REFERENCE.md | Every Blueprint node type explained with real examples | 15,000+ |
| BLUEPRINT_PATTERNS.md | 15 reusable Blueprint patterns for common tasks | 14,000+ |
| BLUEPRINT_TROUBLESHOOTING.md | Common problems and solutions with step-by-step fixes | 16,000+ |
Total Content: 76,000+ characters of beginner-friendly learning materials
What You'll Learn
Level 1 - Fundamentals (0-2 hours):
- What are Blueprints and why use them?
- Understanding nodes, pins, and execution flow
- Creating your first 3 Blueprints (Hello World, Counter, Health Checker)
- Common patterns and debugging techniques
Level 2 - MVP Features (2-6 hours):
- Building trading UI widgets
- Creating flyable spaceships
- Implementing docking systems
- Managing cargo and inventory
Level 3 - Advanced (6-12 hours):
- Complex system integration
- AI behavior implementation
- Performance optimization
- Event-driven architecture
Level 4 - Mastery (Ongoing):
- C++/Blueprint integration
- Custom system design
- Contributing to Adastrea
- Teaching and mentoring
Quick Links
- New to Blueprints? โ Blueprint Fundamentals
- Need Node Info? โ Node Reference
- Looking for Patterns? โ Patterns Library
- Having Problems? โ Troubleshooting Guide
docs/systems/ - Game System Documentation
1 file - Comprehensive guides for game systems:
| File | Purpose |
|---|---|
| STATION_EDITOR_COMPLETE_GUIDE.md | Complete guide for space station building system |
Note: Most system documentation is in the Assets/ directory (see below).
docs/development/ - Developer Documentation
26 files - Guides for developers working on the codebase:
Blueprint Development
| File | Purpose |
|---|---|
| BLUEPRINT_GUIDE_FOR_BEGINNERS.md | Complete Blueprint development guide (1146 lines) |
| BLUEPRINT_GUIDE_TEMPLATE.md | โญ NEW Standard template for all Blueprint guides (Jan 2026) |
| BLUEPRINT_GUIDE_STANDARDS.md | โญ NEW How to write consistent, step-by-step Blueprint guides |
| Blueprints/README.md | โญ NEW Blueprint guide navigation and status tracker |
| BLUEPRINT_MOCKUP_GUIDE.md | Visual Blueprint documentation standards and patterns |
| BLUEPRINT_DOCUMENTATION_EXAMPLES.md | Before/after examples showing visual vs text documentation |
| BP_IMPORTAI_README.md | AI import system for Blueprints |
Plugin and Tool Development
| File | Purpose |
|---|---|
| DIRECTOR_KNOWLEDGE_BASE.md | AI tool knowledge base |
| DIRECTOR_PLUGIN_OVERVIEW.md | Plugin architecture overview |
| PLUGIN_DEVELOPMENT_GUIDE.md | Creating and developing plugins |
| MCP_REMOTE_PYTHON_PLAN.md | MCP automation plan |
| UE_PLUGIN_FEASIBILITY_REPORT.md | Plugin feasibility analysis |
Core Development
| File | Purpose |
|---|---|
| PLAYER_CHARACTER_ARCHITECTURE.md | โญ NEW Player character architecture (MVP + Post-MVP) (Jan 2026) |
| ENHANCED_INPUT_GUIDE.md | Enhanced Input system setup |
| MODULE_DEPENDENCY_GUIDE.md | Managing module dependencies |
| PERFORMANCE_IMPROVEMENTS.md | Performance optimization strategies |
| QUALITY_ASSURANCE_SYSTEMS.md | QA processes and systems |
| STUB_AND_PLACEHOLDER_AUDIT.md | Code completeness tracking |
| UE_COPILOT_MODIFICATIONS_GUIDE.md | GitHub Copilot customization |
| UNREAL_MCP_GUIDE.md | Unreal MCP integration |
Unreal Best Practices
| File | Purpose |
|---|---|
| UNREAL_DIRECTIVE_QUICK_START.md | Unreal Directive quick start |
| UNREAL_DIRECTIVE_SUGGESTIONS.md | Unreal Directive best practices |
UI and Widgets
| File | Purpose |
|---|---|
| WIDGET_ARCHITECTURE_DIAGRAM.md | Widget system architecture |
| WIDGET_INITIALIZATION_GUIDE.md | Widget initialization patterns |
| WIDGET_SETUP_QUICKSTART.md | Quick widget setup guide |
| TAB_MENU_ARCHITECTURE_DIAGRAM.md | Tab menu system architecture |
| TAB_MENU_SETUP_GUIDE.md | Tab menu setup guide |
Camera Systems
| File | Purpose |
|---|---|
| FREE_LOOK_README.md | Free look camera system |
Roadmaps
Note: Consolidated to single ROADMAP.md focused on Trade Simulator MVP (Dec 29, 2025). Area-specific roadmaps removed.
| File | Purpose |
|---|---|
| ROADMAP.md | Single MVP-focused roadmap (12-week Trade Simulator) |
docs/setup/ - Installation and Setup
14 files - Getting your development environment ready:
Project Setup
| File | Purpose |
|---|---|
| SETUP_CHECKLIST.md | Complete setup checklist |
| BUILD_WITH_UE_TOOLS.md | Building with UE tools only (~500MB vs 50GB) |
| PROJECT_GENERATION_QUICK_FIX.md | Fixing project generation errors |
| VISUAL_STUDIO_PROJECT_GENERATION.md | Visual Studio project setup |
Cloud and CI/CD
| File | Purpose |
|---|---|
| CLOUD_BUILD_QUICK_START.md | Cloud CI/CD quick start |
| CLOUD_BUILD_SERVICES.md | Cloud build services comparison |
| DOCKER_SETUP_QUICK_REFERENCE.md | Docker setup quick reference |
| DOCKER_TROUBLESHOOTING_QUICK_REFERENCE.md | Docker troubleshooting |
| GITHUB_TOKEN_DOCKER_SETUP.md | GitHub Actions + Docker setup |
UI and HUD Setup
| File | Purpose |
|---|---|
| SPACESHIP_HUD_BLUEPRINT_GUIDE.md | โญ Comprehensive spaceship HUD (WBP_Spaceship) Blueprint guide |
| CROSSHAIR_BLUEPRINT_GUIDE.md | Crosshair Blueprint implementation |
| FREE_LOOK_SETUP_GUIDE.md | Free look camera setup |
Station and Module Setup
| File | Purpose |
|---|---|
| STATION_MODULE_BLUEPRINTS_GUIDE.md | โญ NEW Complete guide for creating BP_SpaceStationModule_* blueprints |
| MOUSE_SENSITIVITY_GUIDE.md | Mouse sensitivity configuration |
Other Setup
| File | Purpose |
|---|---|
| WIKI_SETUP_INSTRUCTIONS.md | Setting up documentation wiki |
| UNREAL_MCP_SETUP_STEPS.md | Unreal MCP setup |
docs/testing/ - Testing Documentation
3 files - Quality assurance and testing:
| File | Purpose |
|---|---|
| TESTING_AUTOMATION_GUIDE.md | Automated testing setup and workflows |
| TESTING_COMPREHENSIVE.md | Complete testing guide |
| TEST_ARCHITECTURE.md | Test system architecture |
docs/content-generation/ - Content Creation Tools
11 files - Scripts and tools for generating game content:
Comprehensive Guides
| File | Purpose |
|---|---|
| MASSIVE_CONTENT_GENERATION_GUIDE.md | Large-scale content generation |
| PROCEDURAL_GENERATION_GUIDE.md | Procedural content systems |
| SCENE_POPULATION_GUIDE.md | Populating levels with actors |
Quick Start Guides
| File | Purpose |
|---|---|
| CONTENT_CREATION_QUICKSTART.md | Getting started with content creation |
| PROCEDURAL_GENERATION_QUICKSTART.md | Quick start for procedural tools |
Data and Import
| File | Purpose |
|---|---|
| YAML_IMPORT_GUIDE.md | Importing YAML data to Unreal |
| YAML_CONVERSION_README.md | YAML conversion overview |
| YAML_TO_ASSETS_CONVERSION_LIST.md | Complete list of YAML files to convert |
| SCHEMA_GUIDE.md | YAML schema validation |
| GOOGLE_SHEETS_GUIDE.md | Google Sheets integration |
| GOOGLE_SHEETS_TEMPLATES.md | Google Sheets template formats |
Scripts and Tools
| File | Purpose |
|---|---|
| SCRIPTS_README.md | Python scripts overview |
| EXAMPLE_DATA_ASSETS.md | Data asset examples |
docs/reference/ - Quick References
21 files - Fast lookups and one-page guides:
Blueprint References
| File | Purpose |
|---|---|
| BLUEPRINT_ARCHITECTURE_GUIDE.md | ๐ Complete blueprint architecture with Mermaid diagrams |
| BLUEPRINT_TREE_DIAGRAM.md | ๐ Visual class hierarchy with Mermaid diagrams |
| DOCKING_SYSTEM_BLUEPRINT_IMPLEMENTATION_GUIDE.md | โญ NEW Complete docking system implementation - all Blueprints, graphs, "Press F" (Jan 2026) |
| DOCKING_SYSTEM_IMPLEMENTATION_SUMMARY.md | โญ NEW Quick start guide for docking implementation (Jan 2026) |
| DOCKING_SYSTEM_QUICK_REFERENCE.md | ๐ Docking system explained (Bay vs Port vs Points) |
| DOCKING_SYSTEM_VISUAL_DIAGRAM.md | ๐ Docking workflows with Mermaid diagrams |
| BLUEPRINT_DOCUMENTATION_SUMMARY.md | ๐ Quick navigation guide |
| BLUEPRINT_QUICK_REFERENCE.md | One-page Blueprint reference |
| BLUEPRINT_REQUIREMENTS_LIST.md | Complete list of required Blueprints |
| BLUEPRINT_IMAGE_GUIDE.md | โญ Image-based Blueprint documentation with SVG diagrams |
| BLUEPRINT_VISUAL_MOCKUP_GUIDE.md | Color-coded Blueprint docs with node details (ASCII) |
| BLUEPRINT_MOCKUP_GUIDE.md | Visual Blueprint documentation standards |
| BLUEPRINT_DOCUMENTATION_EXAMPLES.md | Visual vs text documentation examples |
General References
| File | Purpose |
|---|---|
| CHEATSHEET.md | Common commands and shortcuts |
| DATA_MANAGEMENT_QUICK_REFERENCE.md | Data asset workflows |
| DEVELOPER_SETUP_QUICK_REF.md | Dev environment quick reference |
| INPUT_CONTROLS_REFERENCE.md | Control schemes and input |
| OPTIMIZATION_QUICK_REFERENCE.md | Performance optimization tips |
| TESTING_QUICK_REFERENCE.md | Testing workflows |
| TROUBLESHOOTING_CASCADING_ERRORS.md | Error resolution guide |
System-Specific References
| File | Purpose |
|---|---|
| SCENE_POPULATION_QUICK_REFERENCE.md | Level population quick ref |
| STATION_EDITOR_VISUAL_GUIDE.md | Visual station editor guide |
| STATION_MODULE_BLUEPRINTS_QUICK_REFERENCE.md | โญ NEW Quick reference for all station module blueprints |
| YAML_TO_ASSETS_QUICK_REFERENCE.md | YAML conversion quick ref |
| X4_QUICK_REFERENCE.md | X4 Foundations inspiration |
Plugin and Tool References
| File | Purpose |
|---|---|
| PLUGIN_QUICK_REFERENCE.md | Plugin quick reference |
| PLUGIN_RECOMMENDATIONS.md | Recommended plugins |
| FREE_PLUGINS_LIST.md | List of free plugins |
| FREE_TOOLS_COMPARISON.md | Tool comparison guide |
Visual Guides
| File | Purpose |
|---|---|
| DA_INPUTCONFIG_VISUAL_GUIDE.md | Data Asset input config visual guide |
| FREE_LOOK_VISUAL_GUIDE.md | Free look camera visual guide |
| IMC_SPACESHIP_VISUAL_GUIDE.md | Spaceship IMC visual guide |
docs/archive/ - Historical Documents
6 files - Archived documentation for reference:
| File | Purpose |
|---|---|
| CHANGES.md | Historical changes log |
| GAME_MOCKUPS.md | Early game mockups |
| INPUT_ACTIONS_ANALYSIS.md | Old input system analysis |
| INPUT_SYSTEM_CLARIFICATION.md | Input system clarification notes |
| ISSUE_RESPONSE_BLUEPRINTS.md | Historical issue responses |
| UPDATED_BLUEPRINT_LIST_2025.md | Old Blueprint list from 2025 |
Assets/ - System-Specific Documentation
102 files - System guides, templates, and designer workflows:
System Guides (Comprehensive Documentation)
All 22+ game systems have complete guides in this directory:
- SpaceshipDataAssetGuide.md - Complete spaceship system
- FactionSetupGuide.md - Complete faction system
- PersonnelSystemGuide.md - Complete personnel/crew system
- TradingSystemGuide.md - Complete trading economy
- WAY_SYSTEM_INDEX.md + WaySystemGuide.md - Complete guild system
- SectorCreationGuide.md - Complete sector/governance system
- CombatSystemGuide.md - Complete combat system
- MaterialSystemGuide.md - Complete material system
- MapSystemGuide.md - Complete map/navigation system
- AISystemIntegration.md - Complete AI system
- HUDSystemGuide.md - Complete HUD/UI system
- QuestSystemGuide.md - Quest system
- ExplorationSystemGuide.md - Exploration/scanning system
- InventorySystemGuide.md - Inventory system
- HomeworldSystemGuide.md - Starting location system
- AudioSystemGuide.md - Audio system
- SaveSystemGuide.md - Save/load system
- PlayerProgressionGuide.md - Progression system
- TutorialSystemGuide.md - Tutorial system
- And many more...
Quick References
- FactionSystemQuickReference.md
- CombatQuickReference.md
- SectorSystemQuickReference.md
- WaySystemQuickReference.md
- HUD_QUICK_REFERENCE.md
- PLAYER_QUICK_REFERENCE.md - โญ NEW Player system quick reference (Jan 2026)
- And more...
Designer Workflows
- SpaceshipDesignerWorkflow.md
- PersonnelDesignerWorkflow.md
- TradingDesignerWorkflow.md
- AIDesignerWorkflow.md
- BlueprintWorkflowTemplates.md
- WayNetworkWorkflow.md
YAML Templates
Multiple template directories with example YAML files:
- SpaceshipTemplates/
- PersonnelTemplates/
- FactionAITemplates/
- PersonnelAITemplates/
- TradingTemplates/
- CombatTemplates/
- InventoryTemplates/
- ShipCustomizationTemplates/
- StationModuleTemplates/
- WayNetworkTemplates/
- SectorTemplates/
- ExplorationTemplates/
- And more...
Special Guides
- DesignerOnboarding.md - Complete designer onboarding
- ADVANCED_DATA_MANAGEMENT.md - Advanced data techniques
- IterationGuide.md - Iterative development
- PlaytestingChecklist.md - QA checklist
- PIE_TESTING_GUIDE.md - Play In Editor testing
- TestingDashboard_EasySetup.md - Testing dashboard setup
- And many more specialized guides...
See Assets/ directory for complete list.
Plugins/ - Plugin Documentation
40 files - AdastreaDirector plugin documentation:
Located in Plugins/AdastreaDirector/:
Main Documentation
- README.md - Plugin overview
- FEATURES.md - Feature list
- INSTALLATION.md - Installation guide
- SETUP_GUIDE.md - Setup guide
- TROUBLESHOOTING.md - Troubleshooting
- MARKETPLACE_README.md - Marketplace listing
Implementation Guides
- CPP_API_QUICK_REFERENCE.md - C++ API reference
- CPP_IMPLEMENTATION_GUIDE.md - C++ implementation
- CPP_IMPLEMENTATION_SUMMARY.md - Implementation summary
- RAG_INTEGRATION.md - RAG system integration
- UE_PLUGIN_CONNECTION_GUIDE.md - UE plugin connection
- UE_PYTHON_API.md - Python API
Testing and Verification
- TESTING_CHECKLIST_WEEKS_1_6.md - Testing checklist
- TESTING_QUICK_REFERENCE.md - Testing quick ref
- VERIFICATION.md - Verification guide
- WEEK1_COMPLETION.md through WEEK7_8_IMPLEMENTATION_SUMMARY.md - Development logs
UI and Features
- STATUS_INDICATORS.md - Status indicators
- TABBED_UI_VISUAL_GUIDE.md - Tabbed UI guide
- UI_ENHANCEMENT_SUMMARY_FOR_USER.md - UI enhancements
Python Environment
Located in Plugins/AdastreaDirector/Python/:
- README.md - Python integration overview
- ENV_MIGRATION_GUIDE.md - Environment migration
- ENV_QUICK_REF.md - Environment quick reference
- ENV_SECURITY_SUMMARY.md - Security considerations
Content and Examples
- Content/Blueprints/BLUEPRINT_GUIDE.md - Blueprint integration
- Content/Examples/README.md - Example content
See Plugins/AdastreaDirector/ for complete documentation.
wiki/ - GitHub Wiki Pages
12 files - GitHub wiki documentation:
Getting Started
- wiki/Home.md - Wiki homepage
- wiki/README.md - Wiki overview
- wiki/Getting-Started/Installation.md - Installation guide
- wiki/Getting-Started/Quick-Start.md - Quick start guide
- wiki/Getting-Started/Designer-Onboarding.md - Designer guide
Core Systems
- wiki/Core-Systems/README.md - Systems overview
- wiki/Core-Systems/Spaceship-System.md - Spaceship system
Developer Guides
- wiki/Developer-Guides/Architecture.md - Architecture
- wiki/Developer-Guides/Code-Style.md - Code style
- wiki/Developer-Guides/Contributing.md - Contributing
Reference
- wiki/Reference/Documentation-Index.md - Documentation index
- wiki/_Sidebar.md - Wiki sidebar navigation
Other Documentation Locations
.github/ Directory
17 files - CI/CD, GitHub configuration, and Copilot instructions:
- copilot-instructions.md - GitHub Copilot custom instructions
- copilot-knowledge.md - Copilot knowledge base
- PULL_REQUEST_TEMPLATE.md - PR template
- instructions/*.instructions.md - Path-scoped Copilot instructions
- agents/ - Custom agent definitions and documentation
Docs/ Directory (Legacy)
45 files - Additional technical documentation (being phased out in favor of docs/):
Contains legacy documentation including:
- AUTOMATION_SETUP.md
- BEST_PRACTICES_CLASS_SETUP.md
- CPP_CODE_QUALITY_REPORT.md
- UNREAL_DIRECTIVE_* guides
- MapSystem guides
- HUD guides
- Player controls guides
- TestMode guides
- archive/migrated/ - 21 archived historical documents
Content/ Directory
3 files - Content organization:
- CONTENT_ORGANIZATION.md - Content organization guide
- Blueprints/STATION_EDITOR_README.md - Station editor tools
- Docs/Blueprint_ModManager_UI.md - Mod manager UI
Blueprints/ Directory
5 files - Blueprint examples and guides:
- HomeworldBlueprintTemplates.md
- ShipStatusScreenBlueprintExample.md
- TradingSystemBlueprintGuide.md
- TradingSystemBlueprintGuide_UPDATED_SAMPLE.md
- WayNetworkBlueprintExamples.md
Tools/ Directory
3 files - Validation and organization tools:
- QUICKSTART_ORGANIZE_CONTENT.md
- README_ORGANIZE_CONTENT.md
- VALIDATION_TOOLS_README.md
Documentation Statistics
Current State (December 24, 2025)
- Root: 11 files (essential only)
- docs/: 78 files organized in 7 categories
- Assets/: 102 files (system documentation)
- Plugins/: 40 files (plugin documentation)
- wiki/: 12 files (wiki pages)
- .github/: 17 files (CI/CD)
- Other: 25 files (scattered locations)
- Total: ~330 markdown files (down from 413)
Before Cleanup (December 23, 2025)
- Root: 172 files (cluttered)
- Total: 413 markdown files
- Issues: Many duplicates, obsolete files, poor organization
Change Summary
- โ Removed 80+ obsolete/duplicate files
- โ 93% reduction in root directory files
- โ Organized into clear category structure
- โ Consolidated overlapping guides
- โ Much easier navigation
Finding Documentation
By Task
Setting Up:
- docs/setup/SETUP_CHECKLIST.md
- docs/setup/BUILD_WITH_UE_TOOLS.md
- docs/setup/VISUAL_STUDIO_PROJECT_GENERATION.md
Creating Blueprints:
- docs/development/BLUEPRINT_GUIDE_FOR_BEGINNERS.md
- docs/reference/BLUEPRINT_QUICK_REFERENCE.md
- docs/reference/BLUEPRINT_REQUIREMENTS_LIST.md
Generating Content:
- docs/content-generation/CONTENT_CREATION_QUICKSTART.md
- docs/content-generation/MASSIVE_CONTENT_GENERATION_GUIDE.md
- docs/content-generation/YAML_IMPORT_GUIDE.md
Testing:
- docs/testing/TESTING_AUTOMATION_GUIDE.md
- docs/testing/TESTING_COMPREHENSIVE.md
- docs/reference/TESTING_QUICK_REFERENCE.md
Quick Answer:
Game Systems:
- Browse Assets/ directory
- Find [System]Guide.md for comprehensive documentation
- Use [System]QuickReference.md for quick lookups
- Check [System]DesignerWorkflow.md for step-by-step processes
Documentation Best Practices
For Contributors
When adding new documentation:
-
Choose the right location:
- System guides โ
Assets/ - Developer guides โ
docs/development/ - Setup guides โ
docs/setup/ - Quick references โ
docs/reference/ - Root only for essential project files
- System guides โ
-
Follow naming conventions:
- Guides:
[System]Guide.mdor[System]SystemGuide.md - Workflows:
[System]DesignerWorkflow.mdor[System]Workflow.md - Quick References:
[System]QuickReference.mdor[TOPIC]_QUICK_REFERENCE.md - Templates:
[System]Templates.md
- Guides:
-
Update this index: Add your new document to the appropriate section
-
Cross-reference: Link to related documentation
-
Keep README updated: Update docs/README.md if adding major documentation
For Maintainers
- Review documentation periodically (quarterly)
- Remove temporary documents after their purpose is served
- Consolidate duplicate guides when discovered
- Use
docs/archive/for historical documents with lasting value - Keep root directory limited to 11 essential files
- Update this index when reorganizing
Related Documents
Active Documentation
- docs/README.md - โญ Complete navigation guide
- GETTING_STARTED.md - โญ Modern MVP-focused entry point
- README.md - Project overview
- ARCHITECTURE.md - System architecture
- ROADMAP.md - MVP development roadmap
- docs/mvp/README.md - Trade Simulator MVP documentation
Historical Archives
- docs/archive/pre-mvp-systems/README.md - โญ Pre-MVP systems (January 2026)
- docs/archive/critical-review-2025/README.md - Critical review (December 2025)
- docs/archive/legacy-Docs/README.md - Legacy documentation (January 2026)
- OBSOLETE_DOCUMENTS.md - Complete archive tracking
Maintenance
Update Frequency
This index should be updated when:
- New documentation is added
- Documentation is reorganized
- File locations change
- Major documentation changes occur
- Quarterly review cycles
Last Updated
Date: January 21, 2026 Updated By: Documentation Review & Cleanup Process Version: 2.3 - Pre-MVP Systems Archive
- Archived 45 non-MVP system files
- Assets/ focused on MVP systems (31 files)
- Root reduced from 11 to 10 files
- Updated all references to archived files
- Added pre-MVP systems archive section
- Aligned all documentation with Trade Simulator MVP focus
Previous Updates:
- v2.2 (January 17, 2026): Blueprint learning materials added
- v2.1 (January 14, 2026): Repository modernization cleanup
- v2.0 (December 24, 2025): Major documentation reorganization (80+ files removed)
Status: โ Complete and MVP-Focused
This comprehensive index provides a complete overview of all documentation in the Adastrea project, now organized with clear focus on the Trade Simulator MVP.