Skip to content

Latest commit

 

History

History

README.md

CAIRA Documentation

Welcome to the CAIRA (Composable AI Reference Architecture) documentation! This directory contains comprehensive guides for developers, contributors, and users working with Azure AI Foundry reference architectures.

📚 Quick Navigation

🚀 Getting Started

🤝 Contributing

🏗️ Architecture Documentation

Reference Architectures

Look here for documentation that details the available configurations.

🎯 Quick Start Paths

For Users

  1. Look here for documentation that details the available configurations.
  2. Troubleshooting - Get help with deployment issues

For New Contributors

  1. 📋 Types of Contributions - Understand how you can help
  2. 🛠️ Environment Setup - Set up your development environment
  3. 🔄 Development Workflow - Learn our contribution process
  4. 📝 Pull Request Guide - Create your first PR

For Developers

  1. 👨‍💻 Developer Guide - Complete development setup
  2. 🏗️ Architecture Documentation - Understand CAIRA components
  3. 🧪 Linting Tools - Code quality requirements
  4. 🔍 Troubleshooting - Resolve common issues

🔧 Development Tools

  • Task Runner: Use task commands for common operations
  • Linting: Automated code quality checks
  • Testing: Terraform validation and integration tests
  • Documentation: Auto-generated from Terraform configurations

📞 Getting Help

  • Issues: Report bugs and request features via GitHub Issues
  • Discussions: Ask questions in GitHub Discussions
  • Documentation: Check existing guides before asking questions

🤝 Community

We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or sharing your experiences, every contribution helps make CAIRA better.


Next Steps: Choose a path above based on your role and goals. All documentation includes step-by-step instructions to get you started quickly.