Phaser Documentation
This directory contains all documentation for the Phaser programming language, organized by audience and purpose.
📚 Documentation Structure
🎯 Language Documentation
For Phaser users, learners, and language designers
- Language design principles and philosophy
- Complete syntax specification and grammar
- Programming patterns and best practices
- Comprehensive examples and tutorials
- Metaprogramming model and capabilities
🔧 Contributing Guide
For compiler developers and project contributors
- Compiler architecture and implementation details
- Development guidelines and workflows
- Testing strategies and specifications
- API design and phase interfaces
- Performance considerations and benchmarks
🚀 Quick Navigation
New to Phaser?
Start with the Language Documentation to understand what Phaser is and how to use it:
- Design Principles - Understand the philosophy
- Language Examples - See Phaser in action
- Grammar Specification - Learn the syntax
- Code Organization - Structure your projects
Want to Contribute?
Check out the ** Contributing Guide** to understand how to help build Phaser:
- Compilation Pipeline - Understand the architecture
- Code Organization - Learn implementation patterns
- Testing Strategy - Follow testing best practices
📖 Document Categories
Language Specification
Documents that define what Phaser is and how it works:
- Grammar and syntax rules
- Type system and semantics
- Metaprogramming model
- Core language features
Programming Guide
Documents that show how to use Phaser effectively:
- Code organization patterns
- Best practices and idioms
- Example programs and use cases
- Module system and project structure
Implementation Guide
Documents for building and extending the Phaser compiler:
- Compiler architecture and phases
- Development workflows and standards
- Testing and validation strategies
- Performance optimization techniques
🔗 Navigation
The documentation uses Obsidian-style [[internal links]] to create an interconnected knowledge graph. You can follow these links to explore related concepts and see how different aspects of the language connect.
📝 Contributing to Documentation
When adding or updating documentation:
- Language Design goes in
docs/language/- anything users need to understand Phaser - Implementation Details go in
docs/contributing/- anything specific to building the compiler - Use cross-references with
[[Document Name]]or[Document Name](./path/to/doc.md)syntax - Include examples to illustrate abstract concepts
- Follow the established structure and naming conventions
📊 Status
🚧 Work in Progress - Phaser is under active development. Documentation may change as the language evolves.
The documentation reflects the current design vision and may include features not yet implemented in the compiler.
Current Focus:
- Finalizing language design specifications
- Building compiler implementation documentation
- Creating comprehensive examples and tutorials