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

๐ŸŽฏ By Role

Learning Blueprints:

Other Roles:

๐Ÿ“‚ By Category


Essential Files (Root Directory)

10 files - Core project documentation that should remain easily accessible:

FilePurposeLines
README.mdProject overview, features, quick start841
ARCHITECTURE.mdSystem architecture and design patterns800+
CODE_STYLE.mdC++ and Blueprint coding standards600+
CONTRIBUTING.mdContribution guidelines and workflow500+
ROADMAP.mdMain development roadmap and vision1304
CHANGELOG.mdVersion history and release notes-
QUICKSTART.mdFast project setup guide-
GETTING_STARTED.mdโญ Modern MVP-focused entry point-
MIGRATION_GUIDE.mdRepository migration guide (January 2026)-
DOCUMENTATION_INDEX.mdThis file - complete documentation index722
OBSOLETE_DOCUMENTS.mdTracking 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

FilePurposeCharacters
README.mdโญ START HERE - Complete learning path with 4 progressive levels11,000+
BLUEPRINT_FUNDAMENTALS.mdComplete beginner's guide to Blueprints - your first steps20,000+
BLUEPRINT_NODE_REFERENCE.mdEvery Blueprint node type explained with real examples15,000+
BLUEPRINT_PATTERNS.md15 reusable Blueprint patterns for common tasks14,000+
BLUEPRINT_TROUBLESHOOTING.mdCommon problems and solutions with step-by-step fixes16,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

docs/systems/ - Game System Documentation

1 file - Comprehensive guides for game systems:

FilePurpose
STATION_EDITOR_COMPLETE_GUIDE.mdComplete 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

FilePurpose
BLUEPRINT_GUIDE_FOR_BEGINNERS.mdComplete 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.mdVisual Blueprint documentation standards and patterns
BLUEPRINT_DOCUMENTATION_EXAMPLES.mdBefore/after examples showing visual vs text documentation
BP_IMPORTAI_README.mdAI import system for Blueprints

Plugin and Tool Development

FilePurpose
DIRECTOR_KNOWLEDGE_BASE.mdAI tool knowledge base
DIRECTOR_PLUGIN_OVERVIEW.mdPlugin architecture overview
PLUGIN_DEVELOPMENT_GUIDE.mdCreating and developing plugins
MCP_REMOTE_PYTHON_PLAN.mdMCP automation plan
UE_PLUGIN_FEASIBILITY_REPORT.mdPlugin feasibility analysis

Core Development

FilePurpose
PLAYER_CHARACTER_ARCHITECTURE.mdโญ NEW Player character architecture (MVP + Post-MVP) (Jan 2026)
ENHANCED_INPUT_GUIDE.mdEnhanced Input system setup
MODULE_DEPENDENCY_GUIDE.mdManaging module dependencies
PERFORMANCE_IMPROVEMENTS.mdPerformance optimization strategies
QUALITY_ASSURANCE_SYSTEMS.mdQA processes and systems
STUB_AND_PLACEHOLDER_AUDIT.mdCode completeness tracking
UE_COPILOT_MODIFICATIONS_GUIDE.mdGitHub Copilot customization
UNREAL_MCP_GUIDE.mdUnreal MCP integration

Unreal Best Practices

FilePurpose
UNREAL_DIRECTIVE_QUICK_START.mdUnreal Directive quick start
UNREAL_DIRECTIVE_SUGGESTIONS.mdUnreal Directive best practices

UI and Widgets

FilePurpose
WIDGET_ARCHITECTURE_DIAGRAM.mdWidget system architecture
WIDGET_INITIALIZATION_GUIDE.mdWidget initialization patterns
WIDGET_SETUP_QUICKSTART.mdQuick widget setup guide
TAB_MENU_ARCHITECTURE_DIAGRAM.mdTab menu system architecture
TAB_MENU_SETUP_GUIDE.mdTab menu setup guide

Camera Systems

FilePurpose
FREE_LOOK_README.mdFree look camera system

Roadmaps

Note: Consolidated to single ROADMAP.md focused on Trade Simulator MVP (Dec 29, 2025). Area-specific roadmaps removed.

FilePurpose
ROADMAP.mdSingle MVP-focused roadmap (12-week Trade Simulator)

docs/setup/ - Installation and Setup

14 files - Getting your development environment ready:

Project Setup

FilePurpose
SETUP_CHECKLIST.mdComplete setup checklist
BUILD_WITH_UE_TOOLS.mdBuilding with UE tools only (~500MB vs 50GB)
PROJECT_GENERATION_QUICK_FIX.mdFixing project generation errors
VISUAL_STUDIO_PROJECT_GENERATION.mdVisual Studio project setup

Cloud and CI/CD

FilePurpose
CLOUD_BUILD_QUICK_START.mdCloud CI/CD quick start
CLOUD_BUILD_SERVICES.mdCloud build services comparison
DOCKER_SETUP_QUICK_REFERENCE.mdDocker setup quick reference
DOCKER_TROUBLESHOOTING_QUICK_REFERENCE.mdDocker troubleshooting
GITHUB_TOKEN_DOCKER_SETUP.mdGitHub Actions + Docker setup

UI and HUD Setup

FilePurpose
SPACESHIP_HUD_BLUEPRINT_GUIDE.mdโญ Comprehensive spaceship HUD (WBP_Spaceship) Blueprint guide
CROSSHAIR_BLUEPRINT_GUIDE.mdCrosshair Blueprint implementation
FREE_LOOK_SETUP_GUIDE.mdFree look camera setup

Station and Module Setup

FilePurpose
STATION_MODULE_BLUEPRINTS_GUIDE.mdโญ NEW Complete guide for creating BP_SpaceStationModule_* blueprints
MOUSE_SENSITIVITY_GUIDE.mdMouse sensitivity configuration

Other Setup

FilePurpose
WIKI_SETUP_INSTRUCTIONS.mdSetting up documentation wiki
UNREAL_MCP_SETUP_STEPS.mdUnreal MCP setup

docs/testing/ - Testing Documentation

3 files - Quality assurance and testing:

FilePurpose
TESTING_AUTOMATION_GUIDE.mdAutomated testing setup and workflows
TESTING_COMPREHENSIVE.mdComplete testing guide
TEST_ARCHITECTURE.mdTest system architecture

docs/content-generation/ - Content Creation Tools

11 files - Scripts and tools for generating game content:

Comprehensive Guides

FilePurpose
MASSIVE_CONTENT_GENERATION_GUIDE.mdLarge-scale content generation
PROCEDURAL_GENERATION_GUIDE.mdProcedural content systems
SCENE_POPULATION_GUIDE.mdPopulating levels with actors

Quick Start Guides

FilePurpose
CONTENT_CREATION_QUICKSTART.mdGetting started with content creation
PROCEDURAL_GENERATION_QUICKSTART.mdQuick start for procedural tools

Data and Import

FilePurpose
YAML_IMPORT_GUIDE.mdImporting YAML data to Unreal
YAML_CONVERSION_README.mdYAML conversion overview
YAML_TO_ASSETS_CONVERSION_LIST.mdComplete list of YAML files to convert
SCHEMA_GUIDE.mdYAML schema validation
GOOGLE_SHEETS_GUIDE.mdGoogle Sheets integration
GOOGLE_SHEETS_TEMPLATES.mdGoogle Sheets template formats

Scripts and Tools

FilePurpose
SCRIPTS_README.mdPython scripts overview
EXAMPLE_DATA_ASSETS.mdData asset examples

docs/reference/ - Quick References

21 files - Fast lookups and one-page guides:

Blueprint References

FilePurpose
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.mdOne-page Blueprint reference
BLUEPRINT_REQUIREMENTS_LIST.mdComplete list of required Blueprints
BLUEPRINT_IMAGE_GUIDE.mdโญ Image-based Blueprint documentation with SVG diagrams
BLUEPRINT_VISUAL_MOCKUP_GUIDE.mdColor-coded Blueprint docs with node details (ASCII)
BLUEPRINT_MOCKUP_GUIDE.mdVisual Blueprint documentation standards
BLUEPRINT_DOCUMENTATION_EXAMPLES.mdVisual vs text documentation examples

General References

FilePurpose
CHEATSHEET.mdCommon commands and shortcuts
DATA_MANAGEMENT_QUICK_REFERENCE.mdData asset workflows
DEVELOPER_SETUP_QUICK_REF.mdDev environment quick reference
INPUT_CONTROLS_REFERENCE.mdControl schemes and input
OPTIMIZATION_QUICK_REFERENCE.mdPerformance optimization tips
TESTING_QUICK_REFERENCE.mdTesting workflows
TROUBLESHOOTING_CASCADING_ERRORS.mdError resolution guide

System-Specific References

FilePurpose
SCENE_POPULATION_QUICK_REFERENCE.mdLevel population quick ref
STATION_EDITOR_VISUAL_GUIDE.mdVisual station editor guide
STATION_MODULE_BLUEPRINTS_QUICK_REFERENCE.mdโญ NEW Quick reference for all station module blueprints
YAML_TO_ASSETS_QUICK_REFERENCE.mdYAML conversion quick ref
X4_QUICK_REFERENCE.mdX4 Foundations inspiration

Plugin and Tool References

FilePurpose
PLUGIN_QUICK_REFERENCE.mdPlugin quick reference
PLUGIN_RECOMMENDATIONS.mdRecommended plugins
FREE_PLUGINS_LIST.mdList of free plugins
FREE_TOOLS_COMPARISON.mdTool comparison guide

Visual Guides

FilePurpose
DA_INPUTCONFIG_VISUAL_GUIDE.mdData Asset input config visual guide
FREE_LOOK_VISUAL_GUIDE.mdFree look camera visual guide
IMC_SPACESHIP_VISUAL_GUIDE.mdSpaceship IMC visual guide

docs/archive/ - Historical Documents

6 files - Archived documentation for reference:

FilePurpose
CHANGES.mdHistorical changes log
GAME_MOCKUPS.mdEarly game mockups
INPUT_ACTIONS_ANALYSIS.mdOld input system analysis
INPUT_SYSTEM_CLARIFICATION.mdInput system clarification notes
ISSUE_RESPONSE_BLUEPRINTS.mdHistorical issue responses
UPDATED_BLUEPRINT_LIST_2025.mdOld 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:

  1. docs/setup/SETUP_CHECKLIST.md
  2. docs/setup/BUILD_WITH_UE_TOOLS.md
  3. docs/setup/VISUAL_STUDIO_PROJECT_GENERATION.md

Creating Blueprints:

  1. docs/development/BLUEPRINT_GUIDE_FOR_BEGINNERS.md
  2. docs/reference/BLUEPRINT_QUICK_REFERENCE.md
  3. docs/reference/BLUEPRINT_REQUIREMENTS_LIST.md

Generating Content:

  1. docs/content-generation/CONTENT_CREATION_QUICKSTART.md
  2. docs/content-generation/MASSIVE_CONTENT_GENERATION_GUIDE.md
  3. docs/content-generation/YAML_IMPORT_GUIDE.md

Testing:

  1. docs/testing/TESTING_AUTOMATION_GUIDE.md
  2. docs/testing/TESTING_COMPREHENSIVE.md
  3. docs/reference/TESTING_QUICK_REFERENCE.md

Quick Answer:

  1. docs/reference/CHEATSHEET.md
  2. docs/reference/*_QUICK_REFERENCE.md (19 files)
  3. MASTER_DOCUMENTATION.md

Game Systems:

  1. Browse Assets/ directory
  2. Find [System]Guide.md for comprehensive documentation
  3. Use [System]QuickReference.md for quick lookups
  4. Check [System]DesignerWorkflow.md for step-by-step processes

Documentation Best Practices

For Contributors

When adding new documentation:

  1. 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
  2. Follow naming conventions:

    • Guides: [System]Guide.md or [System]SystemGuide.md
    • Workflows: [System]DesignerWorkflow.md or [System]Workflow.md
    • Quick References: [System]QuickReference.md or [TOPIC]_QUICK_REFERENCE.md
    • Templates: [System]Templates.md
  3. Update this index: Add your new document to the appropriate section

  4. Cross-reference: Link to related documentation

  5. 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

Active Documentation

Historical Archives


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.