Documentation Index
Fjarr is developed documentation-first: specs and ADRs land before the code that implements them (docs/13). This index is the front door — read top to bottom for the full picture, or jump by concern.
Status meaning: draft (being written, expect churn) → review (complete,
awaiting scrutiny) → stable (normative; changing it requires an ADR or PR
with rationale).
| # | Document | Concern | Status |
|---|---|---|---|
| 00 | Vision | Why Fjarr exists, for whom, and what it is not | review |
| 01 | Glossary | Shared vocabulary across all three codebases | review |
| 02 | Architecture | Three-tier library model, planes, topologies | review |
| 03 | Product strategy | The living SaaS business plan | review |
| 04 | Supported platforms | OS, GPU, browser, network matrices | review |
| 05 | Extension model | The capability/plugin API — the centerpiece | review |
| 06 | Capabilities | Catalog: camera, desktop, telemetry, files, terminal, observability, OTA | review |
| 07 | Desktop backends | X11/Wayland × XTest/libei/uinput evaluation plan | review |
| 08 | Protocol | Normative wire spec: signaling + DataChannels | review |
| 09 | Interfaces | The three embedding APIs + backend contract | review |
| 10 | Security | Threat model, identity, tokens, TURN, privileges | review |
| 11 | Prior art | Lessons mined from drever_webrtc, rcartc, relox_daemon | review |
| 12 | Development environment | Devcontainer, compose, doctor, troubleshooting | review |
| 13 | Development workflow | Doc-driven process, ADRs, definition of done | review |
| 14 | Dependencies | Every dependency: version, license, ships-or-dev | review |
| 15 | Testing strategy | Test pyramid, fault injection, latency harness | review |
| 16 | Performance budgets | Latency/bitrate/CPU targets and degradation | review |
| 17 | Roadmap | Milestones M0–M8 with entry/exit gates | review |
| 18 | Open questions | Live list of undecided items | living |
| 19 | Website & publishing | How docs + landing page ship | review |
| 20 | Agentic development | AI agents as first-class contributors | review |
Architecture decision records
Section titled “Architecture decision records”Decisions live in docs/adr/ — one file per decision, immutable once accepted (superseded, never edited). Start with the ADR process and the template.
Reading paths
Section titled “Reading paths”- “I’m a robot company evaluating Fjarr” → 00 → 02 → 06 → 09 → 04
- “I’m implementing a milestone” → 17 → the specs it gates on → 13
- “I’m writing a capability plugin” → 05 → 08 → 09
- “I’m reviewing security” → 10 → 08 → 09 → 14