alex
a01e6252f5
- Add docs/features/terminal.md with user guide, connection states, keyboard shortcuts, protocol details, and troubleshooting - Update docs/architecture/frontend.md with terminal component stack, connection hook behavior, and data flow diagrams - Update docs/architecture/backend.md with terminal system architecture, protocol reference, message batching, and reconnect behavior - Update docs/README.md to include terminal in feature list
3.0 KiB
3.0 KiB
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
- Web Terminal - Interactive terminal for tool instances
- 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.