Skip to content
HeliosDB Full

HeliosDB Quick Reference

HeliosDB Quick Reference

Fast navigation guide for the reorganized HeliosDB project.

📁 Where to Find Things

Getting Started

  • Main README → README.md
  • Quick Start → README.md or docs/GETTING_STARTED.md
  • Contributing → CONTRIBUTING.md
  • Documentation Index → DOCUMENTATION_INDEX.md

🐳 Deployment

  • All deployment files → deployment/
  • Docker images → deployment/docker/images/
  • Docker Compose (dev) → deployment/docker/compose/development/
  • Docker Compose (prod) → deployment/docker/compose/production/
  • Kubernetes → deployment/kubernetes/
  • Deployment guides → deployment/README.md and deployment/docs/

Benchmarks

  • All benchmarks → benchmarks/
  • Workspace benchmarks → benchmarks/code/workspace/
  • Crate benchmarks → <crate-name>/benches/
  • Benchmark results → benchmarks/results/ and docs/benchmarks/results/
  • Benchmark scripts → benchmarks/scripts/

Scripts

  • All scripts → scripts/
  • Deployment scripts → scripts/deployment/
  • Testing scripts → scripts/testing/
  • Verification scripts → scripts/verification/
  • Utility scripts → scripts/utilities/
  • Benchmark automation → scripts/benchmarks/

📚 Documentation

  • All documentation → docs/
  • Session reports → docs/reports/sessions/
  • Feature completions → docs/reports/completion/
  • Planning documents → docs/planning/
  • Analysis reports → docs/analysis/
  • Quick starts → docs/quick-starts/
  • Architecture → docs/architecture/

🗄 Archives

  • Benchmark archives → benchmarks/results/archive/
  • Analysis archives → docs/analysis/archive/
  • Utility script archives → scripts/utilities/archive/
  • Test archives → tests/archive/

Common Tasks

Deploy HeliosDB

Development (simple):

Terminal window
cd deployment/docker/compose/development
docker-compose -f docker-compose.simple.yml up

Development (full cluster):

Terminal window
cd deployment/docker/compose/development
docker-compose up

Production:

Terminal window
cd deployment/docker/compose/production
docker-compose up -d

Kubernetes:

Terminal window
kubectl apply -k deployment/kubernetes/production

Run Benchmarks

All benchmarks:

Terminal window
cargo bench

Workspace benchmarks:

Terminal window
cd benchmarks/code/workspace
cargo bench

Specific crate:

Terminal window
cd heliosdb-storage
cargo bench

Build Docker Images

Development:

Terminal window
docker build -f deployment/docker/images/Dockerfile -t heliosdb:dev .

Production:

Terminal window
docker build -f deployment/docker/images/Dockerfile.production -t heliosdb:prod .

Lite:

Terminal window
docker build -f deployment/docker/images/Dockerfile.lite -t heliosdb:lite ./heliosdb-lite

Run Tests

All tests:

Terminal window
cargo test

With test scripts:

Terminal window
scripts/testing/RUN_ADVANCED_TESTS.sh

Verify Installation

Terminal window
scripts/verification/verify_test_coverage.sh

📖 Documentation Quick Links

TopicLocation
Deployment Overviewdeployment/README.md
Docker Images Guidedeployment/docs/DOCKER_IMAGES.md
Docker Compose Guidedeployment/docs/DOCKER_COMPOSE.md
Kubernetes Guidedeployment/docs/KUBERNETES.md
Benchmarks Overviewbenchmarks/README.md
Complete Reorganizationdocs/REORGANIZATION_COMPLETE_SUMMARY.md
File Reorganization (Nov 14)docs/FILE_REORGANIZATION_NOV14_2025.md
Project Roadmapdocs/roadmap/V7_0_COMPLETE_ROADMAP.md
User Guide Indexdocs/USER_GUIDE_INDEX.md
Feature Developmentdocs/FEATURE_DEVELOPMENT_PROTOCOL.md

Finding Specific Information

By Type

WhatWhere
Session summariesdocs/reports/sessions/
Agent reportsdocs/reports/agents/
Phase completionsdocs/reports/phase/
Feature completionsdocs/reports/completion/
Hive Mind reportsdocs/reports/distributed execution/
Planning docsdocs/planning/
Performance analysisdocs/analysis/performance/
Security analysisdocs/analysis/security/
Code analysisdocs/analysis/codebase/

By Topic

TopicLocation
Dockerdeployment/docker/
Kubernetesdeployment/kubernetes/
Monitoringdeployment/monitoring/
Benchmarksbenchmarks/
Scriptsscripts/
Teststests/
Source Codesrc/

Directory Overview

HeliosDB/
├── deployment/          # All deployment configurations
├── benchmarks/          # All benchmarks and results
├── scripts/             # All automation scripts
├── docs/                # All documentation
├── src/                 # Source code
├── tests/               # Test code
└── [5 essential .md]    # README, CHANGELOG, etc.

🆘 Getting Help

  • Documentation Index: DOCUMENTATION_INDEX.md
  • Deployment Help: deployment/README.md
  • Benchmark Help: benchmarks/README.md
  • Troubleshooting: deployment/docs/TROUBLESHOOTING.md

Statistics

  • Root Files: 5 (only essentials)
  • Deployment Files: 41
  • Benchmark Files: 36
  • Script Files: 43
  • Documentation Files: 2,250+

Project Structure Philosophy

  1. Root directory - Only essential project files
  2. deployment/ - Everything needed to deploy HeliosDB
  3. benchmarks/ - Everything related to performance testing
  4. scripts/ - All automation and utility scripts
  5. docs/ - All documentation, organized by purpose
  6. src/ - Source code (unchanged)
  7. tests/ - Test code (unchanged)

Last Updated: November 14, 2025 For detailed information, see: DOCUMENTATION_INDEX.md