Software Index

Purpose

Organize the ShadowHound software stack documentation, including ROS 2 packages, simulation tooling, and automation scripts.

Prerequisites

• Working ROS 2 Humble development environment.
• Familiarity with the repository layout (src/, launch/, docs/).

Steps

1. Review the quick links below for setup guides and automation tools.
2. Generate auto-documentation stubs by running python tools/ros2_autodoc.py after package changes.
3. Use Autodoc landing to locate generated package references.

Quick Links

• ROS 2 Workstation Setup
• DIMOS Integration Quick Start
• Script Catalog
• Environment Configuration Guide
• Start Script Reference
• Isaac Sim Remote Streaming

By Topic

LLM & AI Integration

• vLLM Quick Start — Local LLM deployment on Thor
• Ollama Setup — Alternative local LLM backend
• Backend Validation — Startup validation system

Web Interface & WebRTC

• WebRTC Configuration — Robot WiFi communication setup
• Web UI Mockup — Design reference

Agent System

• DIMOS Agent Architecture — Agent system design

Configuration

• Environment Variables — Complete variable reference
• Embeddings Auto-Detection — ChromaDB setup
• vLLM Environment Example — Configuration template

Auto-Generated API Documentation

• Autodoc Index — ROS 2 package API documentation

Validation

• [ ] Autodoc stubs regenerate without errors
• [ ] All setup guides reference validated commands
• [ ] MkDocs navigation renders the same hierarchy as the vault
• [ ] All subdirectories have README index pages

See Also

• Development Documentation — Git workflows and policies
• Hardware Documentation — Robot and sensor setup
• Networking Documentation — DDS and WebRTC connectivity
• Troubleshooting Index — Diagnostic procedures

References

• Documentation Root
• tools/ros2_autodoc.py — Auto-generate package documentation
• tools/link_convert.py — Convert wikilinks for GitHub Pages