57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
/**
|
|
@mainpage YAZE Documentation
|
|
@tableofcontents
|
|
*/
|
|
|
|
# YAZE Documentation
|
|
|
|
Welcome to the YAZE documentation. This site covers installation, usage, and development of the YAZE ROM editor for The Legend of Zelda: A Link to the Past.
|
|
|
|
---
|
|
|
|
## Quick Links
|
|
|
|
| Goal | Start Here |
|
|
|------|------------|
|
|
| **Get started** | [Getting Started](overview/getting-started.md) |
|
|
| **Build from source** | [Build Quick Reference](build/quick-reference.md) |
|
|
| **Understand the code** | [Architecture Overview](developer/architecture.md) |
|
|
| **Fix build issues** | [Build Troubleshooting](build/troubleshooting.md) |
|
|
| **Use the CLI** | [z3ed CLI Guide](usage/z3ed-cli.md) |
|
|
|
|
---
|
|
|
|
## Documentation Sections
|
|
|
|
### Getting Started
|
|
- [Getting Started](overview/getting-started.md)
|
|
|
|
### Build and Tooling
|
|
- [Build Quick Reference](build/quick-reference.md) - Essential build commands
|
|
- [Build from Source](build/build-from-source.md) - Full build guide
|
|
- [CMake Presets](build/presets.md) - Preset reference
|
|
- [Platform Compatibility](build/platform-compatibility.md) - OS-specific notes
|
|
- [Build Troubleshooting](build/troubleshooting.md) - Common issues
|
|
|
|
### Usage Guides
|
|
- [Dungeon Editor](usage/dungeon-editor.md) - Room editing guide
|
|
- [z3ed CLI](usage/z3ed-cli.md) - Command-line interface
|
|
- [Web App](usage/web-app.md) - Browser-based editor (preview)
|
|
- [Overworld Loading](usage/overworld-loading.md) - Technical reference
|
|
|
|
### Developer Guides
|
|
- [Architecture Overview](developer/architecture.md) - System design
|
|
- [Testing Guide](developer/testing-guide.md) - Test organization and execution
|
|
- [Debugging Guide](developer/debugging-guide.md) - Debugging workflows
|
|
- [Canvas System](developer/canvas-system.md) - UI canvas reference
|
|
- [Palette System](developer/palette-system-overview.md) - Color handling
|
|
|
|
### Reference
|
|
- [ROM Reference](reference/rom-reference.md) - ROM data structures
|
|
- [z3ed Command Reference](reference/z3ed-command-reference.md) - CLI commands
|
|
- [Changelog](reference/changelog.md) - Version history
|
|
|
|
---
|
|
|
|
**Internal Documentation:** Development plans, agent workflows, and architecture deep-dives are in [docs/internal/](../internal/README.md).
|