heimdall

📚 Heimdall Documentation

Welcome to Heimdall - AI-powered radio source localization platform.

---

🚀 Getting Started

New to Heimdall? Start here:

1. Quick Start (5 min) - Installation and setup
2. Architecture Overview - How the system works
3. API Reference - REST endpoints and usage

---

📖 Core Documentation

System Guides

• Quick Start Guide - Get running in 5 minutes
• Architecture Guide - System design and components
• API Reference - Complete REST API documentation
• RBAC User Guide - Role-based access control and sharing ✨ NEW

ML & Training

• Training Guide - Machine learning model training
• Training API - Training endpoints and workflow
• SRTM Terrain Data - Real terrain integration for RF propagation

Features & Workflows

• Batch Extraction - Automated feature extraction
• Pause/Resume Training - Pause and resume ML jobs
• Import/Export - Data backup and restoration
• Import/Export UI - UI for data management
• Constellations & Sharing - Manage SDR groups and share with users ✨ NEW

Development

• Development Guide - Contributing, setup, CORS, frontend dev
• Testing Guide - Running tests and adding new tests
• Release Workflow - How to create releases
• RBAC Implementation - Technical RBAC implementation details

---

🛠️ Support

• FAQ - Frequently asked questions
• Troubleshooting Guide - Common issues and solutions

---

📊 Project Information

• Development Roadmap - Phase-by-phase progress (Phase 7/11 - Frontend)
• Contributing Guidelines - How to contribute
• Changelog - Version history
• WebSDR Configuration - Receiver network setup

---

📞 Getting Help

• GitHub Issues: Report bugs
• GitHub Discussions: Ask questions
• Email: alessio.corsi@gmail.com

---

Last Updated: November 2025

Status: Phase 7 - 95% Complete (Frontend + RBAC ✅)