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

Enhance z3ed Documentation and CLI Design

Browse Source 
- Updated E6-z3ed-cli-design.md to reflect the current state and design goals of the z3ed CLI, emphasizing its evolution into a powerful tool for ROM hacking with AI integration.
- Introduced E6-z3ed-reference.md as a comprehensive technical reference, detailing command usage, implementation guides, and troubleshooting tips.
- Expanded README.md to provide a clearer overview of z3ed, including documentation structure and quick start guides for users.
- Enhanced the archive README.md to clarify the purpose of archived documents and their relevance to the project's history and technical decisions.
This commit is contained in:
scawful
2025-10-02 09:27:07 -04:00
parent 983ef24e4d
commit eb61b3cf0d
6 changed files with 1608 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/z3ed/archive/README.md
View File

@@ -1,6 +1,82 @@
# z3ed Documentation Archive
This folder contains historical documentation that was useful during development but is no longer actively maintained. These files are kept for reference and to understand the project's evolution.
**Last Updated**: October 2, 2025
## Purpose
This archive contains historical documentation from the z3ed development process. These documents capture implementation decisions, progress logs, and technical investigations that led to the current design.
**⚠️ Note**: These documents are **historical references only**. For current information, see the main documentation in the parent directory.
## Archive Contents
### Technical Investigations
- **IT-01-grpc-evaluation.md** - gRPC vs alternatives analysis (decision: use gRPC)
- **GRPC_TECHNICAL_NOTES.md** - gRPC implementation details and lessons learned
- **DEPENDENCY_MANAGEMENT.md** - Build system and dependency strategy
### Implementation Progress Logs
- **GRPC_TEST_SUCCESS.md** - IT-01 Phase 1 completion (gRPC infrastructure working)
- **IT-01-PHASE2-IMPLEMENTATION-GUIDE.md** - TestManager integration guide
- **IT-01-PHASE3-COMPLETE.md** - Full ImGuiTestEngine integration completion
- **IT-01-getting-started-grpc.md** - Early gRPC setup guide
### Session Summaries
- **STATE_SUMMARY_2025-10-01.md** - October 1 status snapshot
- **STATE_SUMMARY_2025-10-02.md** - October 2 status snapshot
- **SESSION_SUMMARY_OCT2.md** - October 2 morning session
- **SESSION_SUMMARY_OCT2_EVENING.md** - October 2 evening session
- **PROGRESS_SUMMARY_2025-10-02.md** - Consolidated progress report
### Implementation Status Reports
- **IMPLEMENTATION_PROGRESS_OCT2.md** - Detailed progress tracking
- **IMPLEMENTATION_STATUS_OCT2_PM.md** - PM session status
- **RUNTIME_FIX_COMPLETE_OCT2.md** - IT-02 runtime fix completion
- **QUICK_TEST_RUNTIME_FIX.md** - Quick validation guide
### Planning & Organization
- **DOCUMENTATION_CONSOLIDATION_OCT2.md** - Documentation cleanup plan
- **DOCUMENTATION_REVIEW_OCT2.md** - Documentation audit results
- **FILE_MODIFICATION_CHECKLIST.md** - Change tracking checklist
## Superseded By
All information in these archived documents has been consolidated into:
1. **[E6-z3ed-cli-design.md](../E6-z3ed-cli-design.md)** - Architecture and design decisions
2. **[E6-z3ed-reference.md](../E6-z3ed-reference.md)** - Technical reference and APIs
3. **[E6-z3ed-implementation-plan.md](../E6-z3ed-implementation-plan.md)** - Current status and roadmap
4. **[IT-01-QUICKSTART.md](../IT-01-QUICKSTART.md)** - Test harness usage guide
5. **[AGENT_TEST_QUICKREF.md](../AGENT_TEST_QUICKREF.md)** - CLI agent test reference
6. **[PROJECT_STATUS_OCT2.md](../PROJECT_STATUS_OCT2.md)** - Current project status
## When to Reference Archive
Use archived documents when:
- Investigating why a particular technical decision was made
- Understanding the evolution of the codebase
- Debugging platform-specific issues covered in technical notes
- Reviewing historical performance metrics or test results
## Retention Policy
These documents are retained for:
- **Historical reference**: Understanding design evolution
- **Troubleshooting**: Platform-specific quirks and workarounds
- **Knowledge transfer**: New contributors understanding project history
Documents may be removed after 6 months if their content is fully superseded and no longer referenced.
---
**Maintained by**: @scawful
**Archive Created**: October 2, 2025
**Purpose**: Preserve development history and technical investigations
## Archived Documentation