docs: clarify coverage architecture for readers - #18
AlexanderLanin merged 3 commits into
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately reflects the implementation and linked known limitations.
Review effort: Balanced
Findings: None
What changed in this PR
Clarifies the coverage architecture from collection and scope through gate evaluation, while documenting implementation limitations.
Changes:
- Adds collection, scope, and evaluation diagrams.
- Defines raw/effective coverage with a worked example.
- Documents backend details and known gate defects.
| File | Description |
|---|---|
docs/architecture/index.rst |
Reorganizes and expands the coverage architecture documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Documentation preview for this pull request is available at: |
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Questions / Comments from @dcalavrezo-qorix have been answered.
feedback was addressed. merging as better-than-before. Can be adjusted later.
Why
The architecture page should help repository users understand what coverage the tool measures, how test results relate to the configured coverage scope, and how the gate reaches its result. The previous page led with Bazel and coverage internals, making those concepts hard to follow for readers who maintain the configuration but do not work on the tooling itself.
What changed