Conversation
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
|
Overall readability score: 54.17 (🟢 +0.04)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
|
|
||
| ## Overview | ||
|
|
||
| The **Organization overview** provides a summary of the repositories belonging to your Git provider organization that you [follow on Codacy](../managing-repositories.md). Here you can compare their statuses and check for items that require your attention. |
There was a problem hiding this comment.
I dont know if this applies to ALL tabs or only the overview / grade / complexity / duplication... I suppose it has to because of permissions. Im just not aware of how this behaves with the new metrics system
Codacy's Analysis Summary0 new issue (≤ 0 minor issue) Review Pull Request in Codacy →
|
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
The documentation updates for the Organization Overview are technically accurate and provide necessary detail for new platform features (e.g., AI Risk Hub, specific plan metrics). No major blockers were identified.
About this PR
- Please update the PR title to a more standard format (e.g.,
docs: update organization overview documentation) and replace the boilerplate description with a brief summary of the changes to help with long-term maintainability.
🗒️ Improve review quality by adding custom instructions.
💡 Codacy uses AI. Check for mistakes.
|
|
||
| | Metric | Description | | ||
| | ------ | ----------- | | ||
| | **Coverage** | _coveredLines / coverableLines_ <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. | |
There was a problem hiding this comment.
⚪ LOW RISK
The formula variables contain underscores which may cause the text to render as italics depending on the Markdown parser.
This might be a simple fix:
| | **Coverage** | _coveredLines / coverableLines_ <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. | | |
| **Coverage** | `coveredLines / coverableLines` <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. | |
| !!! important | ||
| The Coverage tab has two modes: | ||
| - On trial and open source plans, you can see the average repository coverage across the 100 most recently updated repositories. This includes visibility into which repositories are above goal, below goal, or without a goal, similar to the Duplication and Complexity tabs. | ||
| - On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode covered in this page. |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: To avoid confusion for users on free plans, consider specifying that the detailed metric descriptions in the following table/list apply specifically to the paid plan version.
This might be a simple fix:
| - On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode covered in this page. | |
| - On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode described in the following section. |
| <div id="overall-quality-chart"></div> | ||
| ### Code health and security |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: Instead of using an empty div for the anchor, you can attach the ID directly to the heading if your documentation engine supports it. This is generally cleaner and less prone to rendering issues.
This might be a simple fix:
| <div id="overall-quality-chart"></div> | |
| ### Code health and security | |
| ### Code health and security {#overall-quality-chart} |
👀 Live preview
🚧 To do