Skip to content

Developer maintenance

The public workbench is kept consistent through four contracts:

  1. ACTION_REGISTRY defines callable scientific parameters and provenance.
  2. USER_ANALYSES is the reviewed non-cohort interface allow-list and documentation slug map.
  3. Existing FastAPI routes adapt browser sessions to the registry without moving science into the web layer.
  4. Validation manifests declare independent expectations before dispatching the real action.

After changing an action, regenerate the agent reference with python scripts/update_circadian_references.py and run its --check mode. After changing the user catalogue, add or update the matching analysis page and run python scripts/check_docs.py.

The real-browser suite is opt-in through the e2e pytest marker. It uses an isolated data root, starts the actual loopback server, drives Microsoft Edge, captures traces only on failure, and verifies shutdown.

The MkDocs source is docs/site/; the built site is written to src/circadian_workbench/static/docs/ so the same guide is available inside the installed application at /docs/.