**Table of Contents**
- [ggen docs](#ggen-docs)
- [🚀 Getting Started with AI (v1.0.0)](#-getting-started-with-ai-v100)
- [📚 Core Documentation](#-core-documentation)
- [Core Concepts](#core-concepts)
- [Advanced Topics](#advanced-topics)
- [Additional Resources](#additional-resources)
- [Integration & Implementation](#integration--implementation)
- [Testing & Validation](#testing--validation)
- [Development & Architecture](#development--architecture)
- [Reference](#reference)
- [Marketplace Ecosystem](#marketplace-ecosystem)
- [Key Benefits](#key-benefits)
- [Workflow](#workflow)
- [Documentation Structure](#documentation-structure)
- [Contributing](#contributing)
- [Support](#support)
# ggen docs
Purpose: project one ontology into many artifacts. Deterministic. Language-agnostic. **AI-powered**.
## 🚀 Getting Started with AI (v1.2.0)
**New to ggen? Start here for AI-powered development:**
1. **[RELEASE_NOTES_v1.0.0.md](RELEASE_NOTES_v1.0.0.md)** - What's new in v1.0.0 *(AI Revolution)*
2. **[install.md](install.md)** - Installation and AI setup
3. **[ai-guide.md](ai-guide.md)** - Complete AI usage guide
4. **[ggen-ai-integration.md](ggen-ai-integration.md)** - Technical AI integration details
5. **[AI_INTEGRATION_CLARIFICATION.md](AI_INTEGRATION_CLARIFICATION.md)** - AI integration approach and CLI commands
6. **[GENAI_GGEN_INTEGRATION_PLAN.md](GENAI_GGEN_INTEGRATION_PLAN.md)** - AI integration roadmap and milestones
7. **[GENAI_OLLAMA_INTEGRATION.md](GENAI_OLLAMA_INTEGRATION.md)** - Ollama provider integration guide
8. **[MULTI_PROVIDER_ANALYSIS.md](MULTI_PROVIDER_ANALYSIS.md)** - Multi-provider AI analysis
9. **[RUNTIME_MODEL_CONFIG.md](RUNTIME_MODEL_CONFIG.md)** - Runtime model configuration
10. **[GENAI_INTEGRATION_STATUS.md](GENAI_INTEGRATION_STATUS.md)** - Current integration status
## 📚 Core Documentation
**Traditional ggen workflow (still supported):**
11. [quickstart.md](quickstart.md) - Quick start with marketplace gpacks
12. [templates.md](templates.md) - Template development guide
13. [marketplace.md](marketplace.md) - Using and publishing gpacks
## Core Concepts
14. [frontmatter.md](frontmatter.md) - Template frontmatter syntax
15. [rdf-shacl-sparql.md](rdf-shacl-sparql.md) - Semantic web integration
16. [projections.md](projections.md) - Code projection patterns
17. [determinism.md](determinism.md) - Reproducible generation
## Advanced Topics
18. [calculus.md](calculus.md) - Mathematical foundations
19. [dx-features.md](dx-features.md) - Developer experience features
20. [gpack-development.md](gpack-development.md) - Creating and publishing gpacks
21. **[CARGO_BEST_PRACTICES.md](CARGO_BEST_PRACTICES.md)** - Cargo.toml optimization and best practices
22. **[BUILD_OPTIMIZATION.md](BUILD_OPTIMIZATION.md)** - Build performance optimization
23. **[TESTING_AND_QUALITY_ASSURANCE.md](TESTING_AND_QUALITY_ASSURANCE.md)** - Comprehensive testing and quality assurance framework
24. **[SECURITY_AND_OBSERVABILITY.md](SECURITY_AND_OBSERVABILITY.md)** - Security controls and observability practices
25. **[CORE_TEAM_RECOMMENDATIONS.md](CORE_TEAM_RECOMMENDATIONS.md)** - Core team recommendations for next development priorities
## Additional Resources
### Integration & Implementation
### Testing & Validation
35. **[E2E_TESTS.md](E2E_TESTS.md)** - End-to-end testing guide
36. **[E2E_TEST_RESULTS.md](E2E_TEST_RESULTS.md)** - Test results and analysis
37. **[DISPLACEMENT_VALIDATION.md](DISPLACEMENT_VALIDATION.md)** - Validation testing framework
### Development & Architecture
38. **[CODE-REVIEW.md](CODE-REVIEW.md)** - Code review guidelines
39. **[GRAPH_VERBS_IMPLEMENTATION.md](GRAPH_VERBS_IMPLEMENTATION.md)** - Graph verb implementation
40. **[GITHUB_API_RUST_INTEGRATION.md](GITHUB_API_RUST_INTEGRATION.md)** - GitHub API integration
## Reference
41. **[CHANGELOG.md](CHANGELOG.md)** - Complete changelog with semantic versioning
42. **[RECENT_FIXES_AND_IMPROVEMENTS.md](RECENT_FIXES_AND_IMPROVEMENTS.md)** - Summary of recent fixes and improvements
43. **[P0-FIXES-APPLIED.md](P0-FIXES-APPLIED.md)** - P0 critical fixes and security assessment
44. **[IMPLEMENTATION_COMPLETE.md](IMPLEMENTATION_COMPLETE.md)** - Core team recommendations implementation summary
45. **[FINAL_STATUS_REPORT.md](FINAL_STATUS_REPORT.md)** - Final status report and project assessment
46. **[DEPLOYMENT.md](DEPLOYMENT.md)** - GitHub Pages deployment guide
47. [cli.md](cli.md) - Complete CLI reference
48. [troubleshooting.md](troubleshooting.md) - Common issues and solutions
49. [examples/](examples/) - Usage examples and tutorials
## Marketplace Ecosystem
The ggen marketplace provides a curated ecosystem of reusable code generation packs (gpacks):
- **Discover**: Search and browse gpacks by language, framework, or use case
- **Install**: Add gpacks to your project with version management
- **Generate**: Use gpack templates for consistent code generation
- **Publish**: Share your own gpacks with the community
### Key Benefits
- **Quality**: Community-tested templates
- **Consistency**: Standardized patterns across languages
- **Maintenance**: Automatic updates and dependency management
- **Collaboration**: Shared knowledge and best practices
### Workflow
1. **Search** for gpacks matching your needs
2. **Install** gpacks and their dependencies
3. **Generate** code using gpack templates
4. **Customize** with local templates if needed
5. **Publish** your own gpacks to contribute back
## Documentation Structure
- **Getting Started**: Installation and quick start guides
- **Core Concepts**: Templates, RDF, projections, determinism
- **Advanced Topics**: Mathematical foundations, DX features, gpack development
- **Reference**: CLI reference, troubleshooting, examples
- **Marketplace**: Ecosystem overview and workflows
## Contributing
- **Documentation**: Improve guides and examples
- **Gpacks**: Create and publish template collections
- **Examples**: Share usage patterns and best practices
- **Feedback**: Report issues and suggest improvements
## Documentation & Search
### 📚 **Complete Documentation Index**
- **Browse All Docs**: [`DOCUMENTATION_INDEX.md`](DOCUMENTATION_INDEX.md) - Complete organized index
- **Search Interface**: [`search.html`](search.html) - AI-powered documentation search
- **Learning Paths**: Structured learning journeys for different experience levels
### 🔍 **Search & Discovery**
- **📚 Documentation Index**: [`DOCUMENTATION_INDEX.md`](DOCUMENTATION_INDEX.md) - Complete organized index of all documentation
- **🔍 Advanced Search Interface**: [`search.html`](search.html) - AI-powered search across all documentation
- **Topic Search**: Find documentation by category, difficulty, and estimated time
- **Keyword Search**: Full-text search across all documentation
- **Auto-Suggestions**: Smart search suggestions as you type
- **Cross-References**: Links between related documents
### 🌐 **Live Documentation Site**
- **📖 GitHub Pages**: [seanchatmangpt.github.io/ggen/](https://seanchatmangpt.github.io/ggen/) - Complete documentation site
- **🔍 Integrated Search**: Built-in search with advanced filtering
- **📱 Mobile Responsive**: Optimized for all devices
- **⚡ Fast Loading**: Optimized performance and caching
## Support
- **Community**: Join discussions and get help
- **Issues**: Report bugs and request features
- **Examples**: Learn from community examples
- **Guides**: Follow step-by-step tutorials
