AzmX Developer Documentation

Central hub for all development guidelines, best practices, and technical documentation for AzmX engineering teams.

Quick Contributing

Essential Guidelines for Adding Content: - 📊 Always use Mermaid diagrams for workflows/processes (fully supported by MkDocs) - 🧪 Test locally with mkdocs serve before submitting changes - 📁 Follow existing structure: tech stacks → 04-technology-stacks/, standards → 03-development-standards/, templates → 08-templates/ - 🗂️ Update navigation section below when adding new files

Local Documentation Server

# Install dependencies and start server
pip install -r requirements.txt
mkdocs serve
# Open http://127.0.0.1:8000

🚀 Getting Started

Team Structure - Engineering team organization and roles
Environment Setup - Port conventions and SSH setup
Development Shortcuts - IDE shortcuts and productivity tools

📏 Development Standards

SOLID Principles - Universal software engineering principles
Code Quality Standards - Quality gates and metrics
Onboarding Standards - Role-specific technical requirements

📏 Development Processes

Team Collaboration Process - Building SOLID quality code together
Semantic Versioning for Leads - Practical versioning with examples
Monorepo Management - Managing pnpm workspaces and multi-package repos
API Versioning & Migrations - API versioning strategies and database migrations
Git Workflow - GitHub Flow implementation
Git Branching Strategy - GitFlow with release management
Git Branch Naming - Structured naming conventions
Git Commit Standards - Conventional commits guide
Pre-commit Hooks - Quality automation with SonarQube integration

🔌 Integrations

DigitalOcean Spaces - S3-compatible storage setup
PostgreSQL Setup - Database + SSH tunneling
Sentry Integration - Error tracking & monitoring
GitHub-ClickUp Quick Start - 20-minute integration setup guide
GitHub-ClickUp Automation - Advanced automation rules and customization
GitHub-ClickUp Troubleshooting - Debug common integration issues
GitHub-ClickUp Workflow - Daily usage patterns and automation

🛠️ Technology Stacks

Frontend: React TypeScript - React with TypeScript setup
Frontend: Storybook Design System - Component library development and publishing
Full-Stack: React Next.js - Next.js 14+ with App Router
Backend: Django 5.2 - Django setup and configuration
Backend: FastAPI Python - FastAPI async patterns and setup
Mobile: React Native - Cross-platform mobile development
Database: PostgreSQL Setup - Database configuration and SSH tunneling
Monitoring: Sentry Integration - Error tracking and monitoring

📄 Templates

📚 References

Git Commands - Essential Git operations and workflows
Docker Commands - Container management and operations
DigitalOcean Commands - Cloud infrastructure management
Development Shortcuts - IDE shortcuts and productivity tools
Environment Setup - Port conventions, SSH
Troubleshooting - Common issues and solutions

Team Information

Total Engineering Team: ~15 members across Frontend (4), Fullstack (3), Backend (2), AI/ML (2), DevOps (2), QA (1), Mobile (2)

Technology Leaders: - Frontend/Mobile Lead - Backend/AI/ML Lead

MkDocs Features

Material Theme: Modern, responsive design with dark/light mode
Search: Full-text search functionality
Mermaid Diagrams: Interactive flowcharts and diagrams
Code Highlighting: Syntax highlighting for all languages
Navigation: Organized sidebar with collapsible sections

Additional Commands

# Build static documentation
mkdocs build

# Deploy to GitHub Pages (if configured)
mkdocs gh-deploy

Contributing

See CONTRIBUTING.md for comprehensive guidelines on contributing to this documentation. (Available at repository root)