Documentation Request: Scheduler and related functions #43
Description
Description
Currently, the scheduler module (and its related functions) is not documented in detail.
Since the scheduler is a core part of Fleet’s orchestration logic (job ordering, dependency resolution, async execution, blocking/non-blocking steps…), proper documentation would help both contributors and users understand how it works internally.
Why
- Improves maintainability for future contributors
- Makes it easier to onboard new developers into the project
- Clarifies how jobs are scheduled, run in parallel, or blocked by dependencies
- Documents the lifecycle of a job (queued → running → completed/failed)
- Helps identify potential issues (e.g., deadlocks, race conditions) more easily
Expected Outcome
A clear and structured documentation of the scheduler:
- High-level description of the scheduling algorithm in the project docs (
/docs) - Example pipeline execution flow that shows how the scheduler resolves jobs and dependencies
Additional Context
The scheduler is one of the most critical components of Fleet, but currently it acts as a "black box" for newcomers.
Proper documentation will make Fleet easier to understand, extend, and debug.