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):

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

Development (full cluster):

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

Production:

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

Kubernetes:

kubectl apply -k deployment/kubernetes/production

Run Benchmarks¶

All benchmarks:

cargo bench

Workspace benchmarks:

cd benchmarks/code/workspace
cargo bench

Specific crate:

cd heliosdb-storage
cargo bench

Build Docker Images¶

Development:

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

Production:

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

Lite:

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

Run Tests¶

All tests:

cargo test

With test scripts:

scripts/testing/RUN_ADVANCED_TESTS.sh

Verify Installation¶

scripts/verification/verify_test_coverage.sh

📖 Documentation Quick Links¶

Topic	Location
Deployment Overview	`deployment/README.md`
Docker Images Guide	`deployment/docs/DOCKER_IMAGES.md`
Docker Compose Guide	`deployment/docs/DOCKER_COMPOSE.md`
Kubernetes Guide	`deployment/docs/KUBERNETES.md`
Benchmarks Overview	`benchmarks/README.md`
Complete Reorganization	`docs/REORGANIZATION_COMPLETE_SUMMARY.md`
File Reorganization (Nov 14)	`docs/FILE_REORGANIZATION_NOV14_2025.md`
Project Roadmap	`docs/roadmap/V7_0_COMPLETE_ROADMAP.md`
User Guide Index	`docs/USER_GUIDE_INDEX.md`
Feature Development	`docs/FEATURE_DEVELOPMENT_PROTOCOL.md`

Finding Specific Information¶

By Type¶

What	Where
Session summaries	`docs/reports/sessions/`
Agent reports	`docs/reports/agents/`
Phase completions	`docs/reports/phase/`
Feature completions	`docs/reports/completion/`
Hive Mind reports	`docs/reports/distributed execution/`
Planning docs	`docs/planning/`
Performance analysis	`docs/analysis/performance/`
Security analysis	`docs/analysis/security/`
Code analysis	`docs/analysis/codebase/`

By Topic¶

Topic	Location
Docker	`deployment/docker/`
Kubernetes	`deployment/kubernetes/`
Monitoring	`deployment/monitoring/`
Benchmarks	`benchmarks/`
Scripts	`scripts/`
Tests	`tests/`
Source Code	`src/`

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¶

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

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