Fusion
40a940304b
- Create enhanced health endpoints with /health and /health/db - Add comprehensive docstrings to all API endpoints - Add Pydantic response models with Field descriptions - Create apps/api/README.md with setup guide - Create ADR-001 for session auth decision - Create ADR-002 for async SQLAlchemy decision - Quality gates: Python syntax OK, TypeScript OK
Headquarter Documentation
Welcome to the Headquarter documentation. This is your central hub for understanding, using, and contributing to the platform.
Quick Links
- Features - Learn about available features
- API Reference - API endpoint documentation
- Architecture - System design and architecture
- Deployment - Setup and deployment guides
- Development - Development and contributing guides
Getting Started
New to Headquarter? Start here:
- Quick Start - Get up and running
- Features - Discover what you can do
- Architecture - Understand the system
Documentation Structure
Features
User guides for each feature:
- Projects - Project management
- Repositories - Git repository management
- Workspace - Repository workspace
- Git History - History visualization
- Authentication - Login and user management
- Settings - User preferences
- Tool Types - Development tool management
- SSH Keys - SSH key management
API Reference
Complete API documentation:
- Auth - Authentication endpoints
- Projects - Project endpoints
- Repositories - Repository endpoints
- Users - User endpoints
- Tool Types - Tool type endpoints
- SSH Keys - SSH key endpoints
Architecture
System architecture documentation:
- Backend - Backend architecture
- Frontend - Frontend architecture
- Database - Database schema
- Deployment - Deployment architecture
Deployment
Guides for deploying Headquarter:
- Docker - Docker setup
- Traefik - Traefik configuration
- Authentik - Authentik setup
- Environment - Environment variables
Development
Guides for developers:
- Setup - Development environment
- Testing - Testing strategy
- Contributing - How to contribute
- Quality Gates - Code quality
Contributing to Documentation
When adding new features, please document them following our templates:
See the Contributing Guide for more details.