Documentation Index

Project Overview

• Project Readme
• Vision
• Milestone Roadmap
• Agents

Architecture

• Architecture Overview
• Filesystem Governance
• Messaging Patterns & Protocols
• Port Allocation
• Microphone Profiles

Services

• Controller · Database · Recorder
• Redis · Web-Mock · Processor · Gateway
• Web-Interface · Icecast · Uploader
• UI/UX Design System
• Web-Interface Feature Specs
• BirdNET · BatDetect · Weather · Tailscale

Deployment

• Deployment Guide (Placeholder)

ADRs

• Architecture Decision Records

Development

• Development Guide
• Commit Message Guidelines — Standardized commit message format
• Milestone v0.1.0 — Concrete implementation plan for Base Setup
• Milestone v0.2.0 — Concrete implementation plan for Service Infrastructure
• Milestone v0.3.0 — Concrete implementation plan for Tier 2 Container Management
• Milestone v0.4.0 — Audio Recording: Dual Stream, Profile Injection, Generic USB Fallback, Watchdog
• Milestone v0.5.0 — Analysis & Backend Orchestration: Processor Service (Indexer + Janitor)
• Milestone v0.6.0 — Uploader (FLAC Compression & Cloud Sync)
• Milestone v0.8.0 — BirdNET (On-device Avian Inference)
• Milestone v0.9.0 — Web-Interface & Field Deployment
• Milestone v0.10.0 — Marketing Landing Page (Astro)
• Milestone v1.0.0 — Production Release & ML Integration
• Milestone Template — Template for new milestone documents
• Service Blueprint — Mandatory patterns for new Python services
• Testing Guide
• Release Checklist — Step-by-step guide for tagging a release
• Future Features & Ideas

User Stories

• Controller · Recorder
• BirdNET · BatDetect
• Processor · Gateway
• Icecast · Uploader
• Web-Interface

Hardware

• Hardware Specifications
• Microphone Profiles

Reference

• API Reference (Planned)
• Glossary — Canonical domain language definitions