MLcreator Documentation

Last Updated: 2025-11-19
Status: ✅ Optimized for Agent Consumption

---

🎯 Quick Navigation

• 📚 Unified Knowledge Base - NEW: Single source of truth
• Agent Documentation Index - Complete guide for AI agents
• Archive - Historical documentation and completed fixes

---

📚 Documentation Organization

📚 Unified Knowledge Base - PRIMARY SOURCE ⭐

Single source of truth - All essential documentation in one organized location:

• 01-critical/ - Must-read files (4 files)

  • AI mandatory checklist, MCP limits, project overview, quick start

• 02-guides/ - How-to guides (13+ files)

  • Setup, multiplayer, troubleshooting, visual scripting guides

• 03-api-reference/ - Technical references (17+ files)

  • GameCreator APIs, Unity references, component documentation

• 04-architecture/ - System design (1+ files)

  • Architecture decisions, fork strategy, system design

• 05-workflows/ - Process documentation (1+ files)

  • Development workflows, OpenSpec processes, team procedures

📦 Archive - Historical Reference

Preserved historical documentation for reference:

• 2025-Nov/ - Recent consolidation (old structure)
• Summaries - Project completion summaries (141+ files)
• Fixes - Completed bug fixes (38+ files)

---

🚀 Quick Start for Agents

1. First-Time Setup

1. Read: _knowledge-base/01-critical/AI_MANDATORY_CHECKLIST.md
2. Read: _knowledge-base/01-critical/Project-Overview.md
3. Read: _knowledge-base/01-critical/MCP_TOKEN_LIMITS_GUIDE.md
4. Browse: _knowledge-base/02-guides/setup/

2. Daily Workflow

1. Check: .openspec/proposals/ for active work
2. Reference: _knowledge-base/02-guides/ for how-to info
3. Use: _knowledge-base/03-api-reference/ for API details
4. Follow: _knowledge-base/01-critical/ for core guidelines

3. Troubleshooting

1. Check: docs/current/guides/troubleshooting/
2. Search: docs/archive/fixes/ for similar issues
3. Review: docs/archive/investigations/ for root causes

---

📊 Documentation Statistics

Category	Files	Purpose
📚 Knowledge Base	~40 essential files	PRIMARY SOURCE - Active documentation
📦 Archive	6,000+ files	Historical reference
🔄 Reduction	99.2% fewer active files	Massive consolidation achieved

🎉 Major Consolidation (2025-11-20)

• ✅ Unified Knowledge Base created with 40 essential files
• ✅ 6,000+ scattered files consolidated and archived
• ✅ Single source of truth established
• ✅ Hierarchical organization (01-critical through 05-workflows)
• ✅ AI-optimized structure for fast parsing and reference

---

🧠 Serena Integration

This documentation is integrated with Serena Brain Mode:

• Memory System: .serena/memories/ (hierarchical knowledge)
• Project Config: .serena/project.yml (AI configuration)
• Proactive Analysis: Monitors documentation health
• Auto-Sync: OpenSpec proposals → Serena memories

---

📁 File Locations

Core Project Files

• .serena/AI_MANDATORY_CHECKLIST.md - Code quality rules
• .serena/project.yml - Serena configuration
• docs/current/core/CLAUDE.md - Project overview
• docs/current/core/AGENTS.md - Agent instructions

Quick References

• docs/current/core/MCP_TOKEN_LIMITS_GUIDE.md - MCP constraints
• docs/current/core/WORKFLOW_QUICK_REFERENCE.md - Fast workflow ref
• docs/AGENT_DOCUMENTATION_INDEX.md - Complete agent guide

Knowledge Base

• .serena/memories/_CRITICAL/ - Must-know knowledge
• .serena/memories/_CORE/ - Core project knowledge
• .serena/memories/_INTEGRATION/ - Integration patterns

---

🔍 Finding Information

By Purpose

Need	Location
Learn stack	docs/current/core/CLAUDE.md
Set up multiplayer	docs/current/guides/multiplayer/
Use Unity MCP	docs/current/guides/unity-mcp/
Fix errors	docs/current/guides/troubleshooting/
API reference	docs/current/reference/
Historical fixes	docs/archive/fixes/

By Technology

Technology	Location
GameCreator	docs/current/reference/gamecreator/
Netcode	docs/current/reference/netcode/
Visual Scripting	docs/current/guides/visual-scripting/
Unity MCP	docs/current/guides/unity-mcp/

---

🎯 Best Practices for Agents

1. Start with Critical Docs

Always read the AI_MANDATORY_CHECKLIST before writing code.

2. Use Current, Not Archive

Focus on docs/current/ - use docs/archive/ only for context.

3. Follow Namespace Rules

All code must be in MLCreator.* namespace (UTF-8 encoding).

4. Respect MCP Limits

MCP tools limited to 25,000 tokens per response - use filters!

5. Check OpenSpec First

Review .openspec/proposals/ before starting new work.

---

📝 Contributing to Docs

Adding New Documentation

• Current guides: docs/current/guides/{category}/
• API references: docs/current/reference/{technology}/
• Core docs: docs/current/core/

Updating Existing Docs

• Update timestamp in header
• Maintain markdown formatting
• Update cross-references
• Run cleanup script if needed

Archiving Completed Work

• Use scripts/simple-doc-cleanup.ps1 -Execute
• Completed fixes → docs/archive/fixes/
• Investigations → docs/archive/investigations/

---

🔗 Related Documentation

• Documentation Super Cleanup Plan - Master plan
• Serena Execution Guide - Serena workflow
• Repository Guidelines - Code organization

---

📞 Getting Help

For Agents

1. Read AGENT_DOCUMENTATION_INDEX.md
2. Check docs/current/guides/troubleshooting/
3. Search docs/archive/ for historical context

For Developers

1. Review .serena/AI_MANDATORY_CHECKLIST.md
2. Follow docs/current/core/WORKFLOW_GUIDE.md
3. Check .openspec/ for active proposals

---

Maintained By: Serena Brain Mode
Auto-Updated: Yes (monitors health, suggests improvements)
Agent-Optimized: Yes (hierarchical, token-efficient, fast-navigation)

---

🎉 Master Cleanup Complete!

✅ 51 files archived - Historical content preserved
✅ Clear structure - Current vs Archive separated
✅ Agent-optimized - Fast navigation, reduced tokens
✅ Well-documented - Comprehensive indexes and guides

Ready for productive agent work! 🚀