This guide is the developer entry point for Robot SF. It covers architecture, contribution workflow, validation gates, CI, and internals. It assumes you can already install and run Robot SF (see the User Guide); it focuses on building and extending the codebase rather than running experiments (see the Research & Benchmark Guide for that).
- Development Guide — concise first-use landing page with setup, validation selection, compatibility anchors, and links to canonical task guides.
- Linked Worktree Lifecycle — create, bootstrap, preserve, and retire isolated worktrees.
- Local CI and PR Readiness — dependency profiles, focused checks, and final readiness.
- Detailed Development Reference — preserved deep procedures and historical anchors during the documentation split.
- Runtime Requirements — non-
uvhost tools and the capability checker. - Environment Configuration — detailed host environment setup.
- UV Migration Notes — migration to the
uvpackage manager. - Subtree Migration Guide — git subtree integration for fast-pysf.
- Contributing — contributor workflow and conventions.
- Agents & Contributor Onboarding — repository structure, coding/testing conventions, workflow tips.
- Agent Workflow Entrypoints — correct
uv runpatterns and validation entrypoints. - Agent Run Manifest — making agent-assisted runs auditable.
- Architecture Decision Records — ADR index.
- Configuration Architecture — configuration hierarchy and precedence.
- Refactoring Overview — refactored environment architecture (status, plan, migration guide, summary).
- Repository Structure Analysis — codebase organization assessment and roadmap.
- Architectural Decoupling (Feature 149) — simulator facade and registries.
- Environment Factory Migration (Feature 130) — factory-pattern migration guidance.
- Benchmark Design — benchmark design, metrics, schema, run commands.
- Occupancy Grid Guide — configure grid observations.
- Helper Catalog — reusable render helpers.
- Coverage Guide — coverage collection, baseline tracking, CI integration.
- Pinned Scenario-Archetype Validation — exact waivers, fail-closed geometry/parameter checks, and the evidence boundary.
- Per-Test Performance Budget — soft/hard test timeouts.
- Code Review Guide — benchmark-facing review criteria, regression traps, semantics, normalization, and provenance review.
- Performance Notes — performance targets and optimization notes.
- Benchmark Planner Quality Audit — planner decision table.
- Mutation Testing Triage — mutation-testing triage notes.
- Planner Contribution Guide — minimum planner/adapter contribution flow, registry, and benchmark boundary.
- Planner Adapter Starter Template — copy-and-adapt reference.
- Scenario Specification Checklist — per-scenario authoring checklist.
- Scenario Zoo — scenario family index.
- Policy Search Context — file-based local policy-search workflow.
- SNQI Weight Tools — recompute, optimize, analyze SNQI weights.
- Pyreverse UML Generation — class diagrams from code.
- Data Analysis Utilities — analysis helpers and data processing tools.
- Imitation Results Analysis — baseline vs pre-trained comparisons.
- Imitation Learning Pipeline — training pipeline overview.
- Dev scripts — shared development entry points (ruff, tests, PR readiness).
- SVG Inspection Workflow — route/zone consistency checks.
- Simulation View — visualization and rendering system.
- LiDAR Configuration Reference — canonical robot/ego scan defaults.
- SVG Map Editor — SVG map creation tooling.
- OSM Map Generation — programmatic map generation from OpenStreetMap.
- Figure Naming Scheme — canonical figure folder naming.
- Pedestrian Metrics Overview — implemented metrics and purpose.
- Metric Analysis — metrics used in research and validation.
- NPC Pedestrian Design — NPC pedestrian design and behavior.
- Pedestrian Density Reference — density canonical triad.
- Need to run or use Robot SF? See the User Guide.
- Need benchmark semantics or evidence grading? See the Research & Benchmark Guide.