1 developer workspace doctor and readiness report
forgejo-actions edited this page 2026-07-11 12:38:13 +00:00

Developer Workspace Doctor And Readiness Report

The developer workspace doctor is the first-run and local-readiness workflow for figuring out why services, gates, profiling, or editor workflows cannot start cleanly.

How It Works

Doctor checks repository setup, environment files, Cargo and rustfmt availability, Postgres, Redis, bind ports, migrations, assets, Tracy tooling, VS Code metadata, and control-service configuration. It can emit markdown for humans or JSON for automation and Control Panel surfaces.

How To Use It

Run doctor before service startup when a machine is new, after toolchain changes, or when quality gates fail for local-environment reasons. Use markdown for interactive diagnosis and JSON when another tool consumes the readiness report.

Fix local-machine setup failures before changing repo code.

Invariants

Doctor should distinguish local setup problems from repository drift. JSON output must remain machine-readable. New required tooling should be added to doctor at the same time it becomes required by workflows.

Debugging

Missing .env values, unavailable databases, occupied ports, stale migrations, missing assets, absent Tracy helpers, and stale generated VS Code metadata are common readiness failures. If doctor disagrees with a gate, compare their source descriptors.