Technical Reference
Developer documentation for HALO Core contributors and maintainers.
Overview
This section provides technical documentation for:
- Developers contributing to the codebase
- DevOps engineers managing deployments
- Maintainers reviewing changes
Documentation Index
| Document | Description |
|---|---|
| Getting Started | Developer quickstart |
| Repository Overview | Codebase structure |
| Architecture and Runtime | System design |
| Agent System | AI agent architecture |
| Data Storage and Retrieval | Data layer |
| UI Panels and Pages | Frontend architecture |
| Development, Testing, and Operations | DevOps |
Quick Reference
Key Directories
halo_core/
├── app/ # Streamlit UI components
├── services/ # Backend services
├── data/ # Persistent data
├── templates/ # Studio templates
├── tests/ # Test suites
└── docs/ # Documentation
Development Commands
# Run application
streamlit run app/main.py
# Run tests
pytest
# Lint and format
ruff check .
black .
# Build docs
mkdocs serve
Key Files
| File | Purpose |
|---|---|
app/main.py |
Application entry point |
services/chat_runtime.py |
Chat orchestration |
services/agents.py |
Agent configuration |
services/knowledge.py |
Knowledge retrieval |
requirements.txt |
Dependencies |
Contributing
See AGENTS.md for contribution guidelines.
Made with ❤️ by Corpus Analytica