Skip to content

Agent instructions

Themed deep-dives for anyone changing Orpheus, human or coding agent. Start at AGENTS.md for the rules that apply to every change; these pages are what it routes to. Numbered by theme, not by reading order — open the one that matches the work.

Page Read it when
00 — Non-negotiables Before anything else. Twelve rules, most tied to a specific past incident
10 — Tooling You are about to run a command. Which make target, which venv, and why never the raw tool
11 — Testing conventions Writing a test. Layout, the auto-skip pattern, and where the coverage floors really live
12 — Git and LFS Staging, committing, or adding a large file
13 — CI/CD Adding a component, or working out why a job did not run
20 — Architecture Orientation: what the components are and which constraints are hard
21 — Event bus and data flow Publishing or subscribing to anything
22 — Schema and migrations Touching the database or a persisted model
30 — Recipe: adding an agent Adding an agent. A checklist, not a guide — every missed entry breaks something
31 — Recipe: schema changes Adding a field that has to survive a restart
32 — Recipe: frontend page Adding a dashboard page or panel
40 — Deployment Orientation for deploy work; the runbooks own the procedures
99 — Gotchas Something behaved strangely and you suspect the environment rather than your change