53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
/**
|
|
@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](overview/getting-started.md)
|
|
|
|
## Build & Tooling
|
|
- [Build From Source](build/build-from-source.md)
|
|
- [Platform Compatibility](build/platform-compatibility.md)
|
|
- [CMake Presets](build/presets.md)
|
|
- [Build Troubleshooting](build/troubleshooting.md)
|
|
|
|
## Usage Guides
|
|
- [Dungeon Editor](usage/dungeon-editor.md)
|
|
- [Overworld Loading](usage/overworld-loading.md)
|
|
- [z3ed CLI](usage/z3ed-cli.md)
|
|
- [Examples & Recipes](examples/)
|
|
|
|
## Developer Guides
|
|
- [Architecture Overview](developer/architecture.md)
|
|
- [Dependency Architecture](developer/dependency-architecture.md)
|
|
- [Git Workflow](developer/git-workflow.md)
|
|
- [Networking Overview](developer/networking.md)
|
|
- [Testing Guide](developer/testing-guide.md)
|
|
- [Testing Without ROMs](developer/testing-without-roms.md)
|
|
- [Debugging Guide](developer/debugging-guide.md)
|
|
- [Debug Flags](developer/debug-flags.md)
|
|
- [Assembler Style Guide](developer/asm-style-guide.md)
|
|
- [API Reference](developer/api-reference.md)
|
|
- [Emulator Development Guide](developer/emulator-development-guide.md)
|
|
- [Canvas System](developer/canvas-system.md)
|
|
- [Palette System Overview](developer/palette-system-overview.md)
|
|
- [Tile16 Palette System](developer/tile16-palette-system.md)
|
|
- [Overworld Entity System](developer/overworld-entity-system.md)
|
|
- [GUI Consistency Guide](developer/gui-consistency-guide.md)
|
|
|
|
## Reference
|
|
- [ROM Reference](reference/rom-reference.md)
|
|
- [Changelog](reference/changelog.md)
|
|
|
|
---
|
|
|
|
Need editor playbooks, refactors, or AI workflows? Head over to [`docs/internal/`](../internal/README.md)
|
|
for internal documentation that stays out of the public Doxygen site.
|