Developer Hub¶

Entry point for developers and contributors to understand, extend, and contribute to Home Security Intelligence.

Quick Start¶

Interactive API Docs: Available at /docs (Swagger UI) when the backend is running.

Architecture¶

System design, data flow, and technology decisions.

AI Pipeline Deep Dives:

• Detection Service - YOLO26 API and bounding boxes
• Batching Logic - Time-windowed batch aggregation
• Risk Analysis - Nemotron prompts and scoring
• Prompt Management - A/B testing and versioning

API Reference¶

Full REST and WebSocket API documentation.

Interactive Docs: Start the backend and visit http://localhost:8000/docs for Swagger UI.

Patterns & Testing¶

Code patterns, testing strategies, and quality standards.

Contributing¶

Everything you need to contribute to the project.

Quick Contribution Workflow¶

# 1. Set up environment
uv sync --extra dev

# 2. Find work in Linear
# https://linear.app/nemotron-v3-home-security/team/NEM/active

# 3. Create branch and implement
git checkout -b feature/my-feature

# 4. Run validation before PR
./scripts/validate.sh

# 5. Create PR
gh pr create --title "feat: my feature"

Key Resources¶

Service Ports¶

AGENTS.md Navigation¶

Every directory contains an AGENTS.md file with purpose, key files, and patterns:

# List all AGENTS.md files
find . -name "AGENTS.md" -type f | head -20

Development Workflow¶

Core development documentation for contributing to the project.

Related Documentation¶

Back to Documentation Index