Developer Guide
Use this guide to understand, change, test, and contribute to QDash. Procedures for operating the product are in the User Guide.
Make Your First Change
- Read Architecture to see the UI, API, and workflow boundaries.
- Follow Development Setup to start a local environment.
- Use Codebase to find the owning package and generated files.
- Choose commands from Command Reference.
- Run the checks selected by Testing.
- Follow Development Flow when preparing the pull request.
Choose a Component
| Area | Owns | Start here |
|---|---|---|
| API | Authentication, project access, persistence, and HTTP contracts | API Design Guidelines |
| UI | Routes, interaction, server state, and presentation | UI Architecture |
| Workflow | Calibration execution, scheduling, parameters, and Prefect integration | Workflow Engine Architecture |
| Copilot | Chat, evaluation, agent execution, and the workspace | Copilot Architecture |
| Cross-component design | Data flow, schedulers, topology, notes, and provenance | Architecture |
Use the component groups in the sidebar to open implementation rules and focused test guides. Use Reference when you need an exact schema, index, generated API, or client contract.
Apply Repository-Wide Conventions
The conventions for datetime handling, logging, and credential scanning apply across component boundaries.
Use Documentation Guidelines for any page under docs/.