Development Documentation
This directory contains all development-related documentation for the MethodGrid project.
Contents
Quick Links
- Meta Documentation - Information about where different types of documentation are stored
- Pull Request Review Guidelines - Team expectations and workflow for reviewing PRs
- Azure OpenAI Access - How to access Azure OpenAI services
- Embedding Domains - Approved domains for embedding the app
- Docker & Kubernetes Overview - Container and orchestration overview
- Release Changes - Breaking changes and new features in releases
- Presentations - Team presentations and workshops
Directories
- workflows/ - Development and refactoring workflows
- procedures/ - Operational procedures and how-to guides
- architectural-decisions/ - Architecture Decision Records (ADRs)
Getting Started
If you're new to the project:
- Review the Meta Documentation to understand where to find different types of docs
- Read through the Development Flow to understand our feature delivery process
- Familiarize yourself with the Pull Request Review Guidelines
- Browse the Architectural Decisions to understand key technical decisions
Contributing
When adding new documentation:
- Place workflow documentation in
workflows/ - Place operational procedures in
procedures/ - Place architectural decisions in
architectural-decisions/following the ADR template - Update the relevant README.md file to include links to your new documentation