yaze/docs/public/index.md

/** @mainpage YAZE Documentation @tableofcontents */

YAZE Documentation

YAZE documentation now focuses on concise, Doxygen-friendly sections. Use the categories below for human-readable guides and reference material. Internal planning, AI agent playbooks, and research notes were moved to docs/internal/ so the public docs stay focused.

Overview

• Getting Started

Build & Tooling

• Build Quick Reference
• Build From Source
• Platform Compatibility
• CMake Presets
• Build Troubleshooting

Usage Guides

• Dungeon Editor
• Overworld Loading
• z3ed CLI
• Examples & Recipes

Developer Guides

• Architecture Overview
• Dependency Architecture
• Git Workflow
• Networking Overview
• Testing Guide
• Testing Without ROMs
• Debugging Guide
• Debug Flags
• Assembler Style Guide
• API Reference
• Emulator Development Guide
• Canvas System
• Palette System Overview
• Tile16 Palette System
• Overworld Entity System
• GUI Consistency Guide
• AI-Assisted Development

Reference

• ROM Reference
• Changelog

---

Need editor playbooks, refactors, or AI workflows? Head over to docs/internal/ for internal documentation that stays out of the public Doxygen site.