This directory contains architectural and educational documentation for the Zyntax compiler project.
- ARCHITECTURE.md - Overall compiler architecture and design
- BYTECODE_FORMAT_SPEC.md - Bytecode format specification
- ASYNC_RUNTIME_DESIGN.md - Async/await runtime design
- PLUGIN_ARCHITECTURE.md - Plugin system architecture
- tiered-compilation.md - Tiered compilation strategy
- EMBEDDING_SDK.md - Embedding Zyntax in Rust applications (zyntax_embed)
- HIR_BUILDER_EXAMPLE.md - HIR (High-level Intermediate Representation) builder examples
- PATTERN_MATCHING.md - Pattern matching implementation and architecture
Located in language-integrations/ directory:
- Haxe Integration - Haxe language integration documentation
- Zyn Parser - Zig language parser implementation
- ../Readme.md - Main project README
- ../BACKLOG.md - Development backlog and task tracking
Session-specific documentation is archived in session-archive/ (untracked by git).
These documents capture implementation progress and decisions from specific development sessions
but are not intended as permanent reference material.
When adding new documentation:
- Architecture/Design docs: Place in
docs/root - Language integration docs: Place in
docs/language-integrations/ - Session-specific status: Place in
docs/session-archive/(will not be committed) - Examples/Tutorials: Place in
docs/with descriptive names
Keep documentation:
- Educational: Focus on "why" not just "what"
- Current: Update when designs change
- Accessible: Use clear language and examples
- Organized: Follow the structure above