Documentation Table of Contents¶
For Users¶
Tutorials¶
- Installation Guide - Step-by-step setup instructions
- Docker Setup - Docker environment setup
- Running Hatchling - Starting the application
User Guides¶
- Chat Commands - Available commands and usage
- Settings - Configuration settings and management
- Language Support - Multi-language interface support
For Developers¶
Development Documentation¶
Documentation for maintainers and contributors working on Hatchling's codebase.
Versioning¶
- Versioning - Versioning strategy and documentation
Architecture¶
- Settings Architecture - Settings system design and patterns
- Event System Architecture - Event-driven communication patterns and implementation
- i18n Support - Internationalization system architecture
Contributing¶
- General Contribution Guidelines - Standards for branches, versioning, and automation
- Contributing Languages - How to add new language translations
- Implementing LLM Providers - Complete guide for adding new LLM providers
Appendices¶
Reference Materials¶
- Glossary - Key terms and definitions
Resources¶
Diagrams¶
- Architecture Diagrams - System architecture documentation
- LLM Provider Architecture - Provider system class diagram
- Provider Interaction Sequence - Provider workflow sequence diagram
- Translation Flow - How the translation files are leveraged to display runtime documentation in different languages
- Settings - How the settings components are related to each other
- Tool Chaining Sequence - How tool chaining plays out
Diagram Sources¶
- PlantUML Sources - Editable source files for architecture and workflow diagrams
Change Log¶
For recent changes and updates, see the CHANGELOG.