Description
The README describes what Checkmate does and lists features, but it does not explain how a monitor actually works internally from check execution to incident creation.
Problem
New contributors may not understand the internal flow of monitoring, specifically:
- How checks are executed
- How monitor status (up/down) is determined
- When and why incidents are created
- How notifications are triggered
Suggested improvement
Add a short section in the README explaining the monitor lifecycle:
- Monitor executes a check (HTTP / ping / port / hardware)
- Result is recorded (success/failure + response time)
- Status is evaluated using thresholds
- If failure conditions are met, monitor status becomes "down"
- Incident is created automatically
- Notifications are sent to configured channels
Why this is useful
This improves onboarding and helps new contributors understand the core monitoring flow without reading backend code.
Description
The README describes what Checkmate does and lists features, but it does not explain how a monitor actually works internally from check execution to incident creation.
Problem
New contributors may not understand the internal flow of monitoring, specifically:
Suggested improvement
Add a short section in the README explaining the monitor lifecycle:
Why this is useful
This improves onboarding and helps new contributors understand the core monitoring flow without reading backend code.