One place to find every learning path: quick starts, structured courses, topic guides, demos, and runnable examples.
New here? Pick a track below — you can switch anytime.
| I want… | Start here | Time |
|---|---|---|
| Plain English, no jargon | Spanda for Dummies | ~45 min read |
| Structured lessons + exercises | Spanda 101 | ~3 hours |
| First robot in 10 minutes | Getting started | ~10 min |
| Browse runnable code | Examples library | self-paced |
| Impress someone in a meeting | Killer demo | ~5 min |
| Mission assurance suite | Mission assurance + spanda demo assurance |
~5 min |
Audience-specific entry points (by role): overview/where-to-start.md
Curated paths for your first programs.
| Tutorial | Format | Best for |
|---|---|---|
| Spanda for Dummies | 7 short chapters, glossary, cheat sheet | Casual readers, managers, first week |
| Spanda 101 | 10 lessons with exercises | Developers learning systematically |
| Getting started | Single quickstart doc | Install → first project → core commands |
| Installation | Platform installers & PATH | Before any hands-on tutorial |
| # | Chapter |
|---|---|
| 1 | What is Spanda, anyway? |
| 2 | Your first five minutes |
| 3 | Anatomy of a robot program |
| 4 | AI without the scary parts |
| 5 | Ten commands cheat sheet |
| 6 | Common mistakes |
| 7 | Glossary |
| # | Lesson | Example |
|---|---|---|
| 1 | Hello, robot | examples/basics/01_minimal_robot.sd |
| 2 | Sensors and safety | 02_sensors_and_safety.sd |
| 3 | Control flow | 03_control_flow.sd |
| 4 | Types and errors | 04_result_and_option.sd |
| 5 | Modules and traits | 05_traits_and_impl.sd |
| 6 | AI and the safety gate | showcase/rover_navigation.sd |
| 7 | Tasks, triggers, concurrency | integration/triggers_minimal.sd |
| 8 | Hardware and verify | integration/verify_walkthrough.sd |
| 9 | Packages and tests | basics/07_in_language_tests.sd |
| 10 | End-to-end patrol | end_to_end/safe_patrol/ |
Scripted flows for talks, evals, and “show me what Spanda does.”
| Walkthrough | What you demonstrate |
|---|---|
| Killer demo | Compile-time AI safety, spanda verify, simulation |
| Killer demo source | Runnable flagship program |
| AI safety violation | Intentional compile error (ActionProposal) |
| Hardware compatibility | Deploy + verify report |
| Release announcement v0.1.0-alpha | Launch copy and positioning |
Deep dives on one capability. Read after a beginner track.
| Topic | Guide | Example directory |
|---|---|---|
| Language syntax | spanda-language.md | examples/types/, examples/basics/ |
| Triggers | triggers.md | examples/triggers_demo.sd |
| Concurrency | concurrency.md | examples/concurrency.sd |
| Real-time | realtime.md | examples/realtime/ |
| Reliability | reliability.md | examples/realtime/watchdog.sd, recovery.sd |
| Watchdogs | watchdogs.md | examples/realtime/watchdog.sd |
| Degraded modes | degraded-modes.md | examples/realtime/degraded_mode.sd |
| Mission replay | replay.md | examples/end_to_end/replay_mission.sd |
| Regex | regex.md | examples/regex/ |
| Hardware & deploy | hardware-compatibility.md | examples/hardware/ |
| Health & kill switch | health-checks.md, kill-switch.md | examples/hardware/capability_verification.sd |
| Capability traceability | capability-traceability.md | spanda trace capabilities … |
| Fleet / swarm health | fleet-health.md, swarm-health.md | examples/features/fleet_health_require.sd |
| Mission assurance | mission-assurance.md | examples/showcase/assurance/, examples/anomaly/, … |
| Mission continuity | continuity-walkthrough.md, mission-continuity.md | examples/showcase/continuity/, spanda demo continuity |
| Self-healing | self-healing.md | examples/showcase/self_healing/, spanda demo self-healing |
| State estimation | state-estimation.md | examples/basics/11_observe_and_fusion.sd, examples/robotics/sensor_fusion.sd |
| Anomaly detection | anomaly-detection.md | examples/anomaly/learned_navigation.sd |
| Diagnostics | diagnostics.md | examples/diagnostics/gps_failure.sd |
| Prognostics | prognostics.md | examples/prognostics/battery_degradation.sd |
| Resilience | resilience.md | examples/resilience/degraded_mode_recovery.sd |
| Readiness | readiness.md | examples/showcase/readiness/, spanda demo readiness |
| Verification diagnostics | verification-diagnostics.md | --verification-json |
| Testing | testing.md | examples/basics/12_compile_fail_tests.sd |
| Typed handler I/O | typed-handler-io.md | examples/features/typed_handler_returns.sd |
| IoT & live bridges | iot.md | examples/iot/modbus_dispatch.sd, ./scripts/live_iot_golden_path.sh |
| Live AI | live-ai-provider.md | examples/features/live_openai.sd |
| Debugging (DAP) | debugging.md | examples/integration/debugger_every.sd |
| Registry & publish | registry.md, packages.md | examples/packages/publish_mirror_project/ |
| Packages | packages.md | examples/packages/ |
| Official packages | official-packages.md | packages/registry/, adapter examples |
| Lean-core / crates | lean-core.md | crates/README.md |
| Standard library | standard-library.md | examples/std/ |
| Type system | spanda-type-system.md | examples/types/ |
| FFI & ROS2 | ffi-and-ecosystem.md | examples/ffi_*.sd, ros2_bridge.sd |
| Architecture | architecture.md | — |
| Migration | migration.md | — |
Master index: examples/README.md — quick start, learning ladder, topic map, CI regression.
Runnable .sd programs grouped by skill level. All paths relative to
examples/.
examples/features/README.md — master index mapping every capability to a runnable file (language core, AI, triggers, hardware, regex, FFI, and more).
| Tier | Directory | Index |
|---|---|---|
| Basics | examples/basics/ |
README |
| Integration | examples/integration/ |
triggers, concurrency, verify |
| Features | examples/features/ |
one file per capability |
| End-to-end | examples/end_to_end/ |
README — patrol, warehouse, fleet, replay, … |
| Packages | examples/packages/ |
README — manifests, adapters, local deps |
| Directory | Focus |
|---|---|
showcase/ |
v0.4 flagship demos (spanda demo, assurance, readiness) |
assurance/ |
Mission assurance declarations |
anomaly/ |
Anomaly detectors and learned backends |
diagnostics/ |
Fault diagnosis |
prognostics/ |
RUL and degradation |
resilience/ |
Resilience and recovery |
mission/ |
Mission plan verification |
features/ |
One file per capability (dyn trait, join, zones, QoS, …) |
realtime/ |
Deadlines, pipelines, watchdogs, replay |
regex/ |
Pattern triggers and validation |
communication/ |
Topics, services, fleet |
hardware/ |
Deploy and compatibility |
modules/ |
Cross-file imports |
types/ |
Type-system snippets |
std/ |
Standard library samples |
packages/ |
spanda.toml project layouts |
examples/)Noteworthy single-file programs: lidar_avoidance.sd, ai_navigation.sd, humanoid_assistant.sd,
multi_robot_fleet.sd (under communication/), warehouse_logistics.sd, platform HAL demos
(esp32_sensors.sd, jetson_inspection.sd, etc.).
Use these when you know what you need; use tutorials when you’re learning how.
| Doc | Use when |
|---|---|
| spanda-reference.md | Keyword, builtin, CLI lookup |
| api-documentation.md | How language, compiler, and JSON API docs relate |
| api-reference.md | Rust/TypeScript compiler API (grouped by crate layer) |
| man/ | Man-page CLI reference |
| feature-status.md | What is stable vs experimental |
| api-contract.json | JSON schemas for tool integration |
examples/basics/01 through 03examples/end_to_end/safe_patrol/examples/realtime/examples/end_to_end/replay_mission.sdexamples/packages/basic_project/examples/packages/ros2_adapter_package/ + ros2-golden-path.mdAdding a new tutorial? See CONTRIBUTING.md:
docs/spanda-for-dummies/ or docs/spanda-101/docs/<topic>.md + runnable example under examples/tests/golden/manifest.jsonspanda check examples/basics/01_minimal_robot.sd
spanda run examples/basics/02_sensors_and_safety.sd
spanda verify examples/integration/verify_walkthrough.sd --target RoverV1
spanda test examples/basics/07_in_language_tests.sd
Build CLI: npm run build:rust → target/release/spanda