HeliosDB User Documentation
HeliosDB User Documentation
This directory provides navigation to HeliosDB user documentation. The primary user documentation is maintained in /docs/guides/user/.
Primary Documentation Hub
User Documentation Index - The main navigation hub for all user documentation, including:
- Getting Started guides
- Protocol compatibility documentation
- AI/ML features
- Performance tuning
- Security configuration
Quick Navigation
| I Want To⦠| Go To |
|---|---|
| Get started quickly | Quick Start Guide |
| Deploy to production | Production Deployment |
| Configure the system | Configuration Guide |
| Tune performance | Performance Tuning |
| Secure my installation | Security Quick Reference |
Directory Structure
/installation/
Getting HeliosDB up and running. See installation/README.md for links to:
- Quick Start and Getting Started guides
- Docker and Production deployment guides
/configuration/
Configuring HeliosDB for your needs. See configuration/README.md for links to:
- Configuration guides and references
- Performance and security configuration
/features/
Feature-specific documentation. See features/README.md for links to:
- AI/ML features (Conversational BI, Vector Search, RAG)
- Database features (Multi-model, Document Store, Geospatial)
- Protocol compatibility (PostgreSQL, Oracle, MySQL)
/operations/
Day-to-day operations documentation:
- Deployment Runbook
- Monitoring Guide
- Health Check Guide
- Incident Response
- Rollback Procedures
- Runbooks - Detailed operational runbooks
/tutorials/
Step-by-step tutorials:
Related Documentation
Quick Starts
- Quick Starts Index - All quick start guides organized by category:
- Getting Started
- Deployment
- Protocols
- Performance
- Security
- Features
Reference Documentation
- Reference Documentation - API and protocol reference
- Architecture Documentation - System design and architecture
Developer Documentation
- Developer Guides - For contributors and developers
Getting Help
- Check the FAQ for frequently asked questions
- See the Quick Reference for common tasks
- Visit HeliosDB Documentation for latest updates
The primary user documentation is maintained in /docs/guides/user/. This directory provides navigation and operational documentation.