scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Consolidate documentation and add git workflow guide

Browse Source
This commit is contained in:
scawful
2025-10-10 17:05:07 -04:00
parent 735d9243fd
commit 83eccaa789
11 changed files with 1763 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/index.md
View File

@@ -10,7 +10,7 @@ Welcome to the official documentation for yaze, a comprehensive ROM editor for T
- [B1: Build Instructions](B1-build-instructions.md) - How to build yaze on Windows, macOS, and Linux.
- [B2: Platform Compatibility](B2-platform-compatibility.md) - Cross-platform support details.
- [B3: Build Presets](B3-build-presets.md) - A guide to the CMake preset system.
- [B4: Release Workflows](B4-release-workflows.md) - GitHub Actions release pipeline documentation.
- [B4: Git Workflow](B4-git-workflow.md) - Branching strategy, commit conventions, and release process.
- [B5: Architecture and Networking](B5-architecture-and-networking.md) - System architecture, gRPC, and networking.
## C: `z3ed` CLI
@@ -20,26 +20,55 @@ Welcome to the official documentation for yaze, a comprehensive ROM editor for T
- [E1: Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards.
- [E2: Development Guide](E2-development-guide.md) - Core architectural patterns, UI systems, and best practices.
- [E3: API Reference](E3-api-reference.md) - C/C++ API documentation for extensions.
- [E4: Emulator Development Guide](E4-Emulator-Development-Guide.md)
- [E5: Debugging and Testing Guide](E5-debugging-guide.md) - A master guide to the SNES emulator subsystem.
- [E4: Emulator Development Guide](E4-Emulator-Development-Guide.md) - SNES emulator subsystem implementation guide.
- [E5: Debugging Guide](E5-debugging-guide.md) - Debugging techniques and workflows.
- [E6: Emulator Improvements](E6-emulator-improvements.md) - Core accuracy and performance improvements roadmap.
- [E7: Debugging Startup Flags](E7-debugging-startup-flags.md) - CLI flags for quick editor access and testing.
- [E8: Emulator Debugging Vision](E8-emulator-debugging-vision.md) - Long-term vision for Mesen2-level debugging features.
## F: Technical Documentation
- [F1: Dungeon Editor Guide](F1-dungeon-editor-guide.md) - A master guide to the dungeon editing system.
- [F1: Dungeon Editor Guide](F1-dungeon-editor-guide.md) - Master guide to the dungeon editing system.
- [F2: Tile16 Editor Palette System](F2-tile16-editor-palette-system.md) - Design of the palette system.
- [F3: Overworld Loading](F3-overworld-loading.md) - How vanilla and ZSCustomOverworld maps are loaded.
- [F4: Overworld Agent Guide](F4-overworld-agent-guide.md) - AI agent integration for overworld editing.
## G: GUI Guides
## G: Graphics & GUI Systems
- [G1: Canvas System and Automation](G1-canvas-guide.md) - The core GUI drawing and interaction system.
- [G2: Renderer Migration Plan](G2-renderer-migration-plan.md) - Historical plan for renderer refactoring.
- [G3: Palette System Overview](G3-palete-system-overview.md) - SNES palette system and editor integration.
- [G3: Renderer Migration Complete](G3-renderer-migration-complete.md) - Post-migration analysis and results.
- [G4: Canvas Coordinate Fix](G4-canvas-coordinate-fix.md) - Technical deep-dive on canvas coordinate synchronization bug fix.
## H: Project Info
- [H1: Changelog](H1-changelog.md)
## I: Roadmap
- [I1: Roadmap](I1-roadmap.md)
## I: Roadmap & Vision
- [I1: Roadmap](I1-roadmap.md) - Current development roadmap and planned releases.
- [I2: Future Improvements](I2-future-improvements.md) - Long-term vision and aspirational features.
## R: ROM Reference
- [R1: A Link to the Past ROM Reference](R1-alttp-rom-reference.md) - Technical reference for ALTTP ROM structures, graphics, palettes, and compression.
---
*Last updated: October 2025 - Version 0.3.3 (In Flux)*
## Documentation Standards
### Naming Convention
- **A-series**: Getting Started & Testing
- **B-series**: Build, Platform & Git Workflow
- **C-series**: CLI Tools (`z3ed`)
- **E-series**: Development, API & Emulator
- **F-series**: Feature-Specific Technical Docs
- **G-series**: Graphics & GUI Systems
- **H-series**: Project Info (Changelog, etc.)
- **I-series**: Roadmap & Vision
- **R-series**: ROM Technical Reference
### File Naming
- Use descriptive, kebab-case names
- Prefix with series letter and number (e.g., `E4-emulator-development-guide.md`)
- Keep filenames concise but clear
---
*Last updated: October 10, 2025 - Version 0.3.2 (Preparing for Release)*