Skip to content

drafting organization overview doc#2589

Closed
claudiacodacy wants to merge 25 commits intomasterfrom
coverage-and-overview-metrics
Closed

drafting organization overview doc#2589
claudiacodacy wants to merge 25 commits intomasterfrom
coverage-and-overview-metrics

Conversation

@claudiacodacy
Copy link
Contributor

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2026

Overall readability score: 54.17 (🟢 +0.04)

File Readability
organization-overview.md 58.69 (🟢 +10.25)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
organization-overview.md 58.69 36.79 9.72 12.7 12.7 6.55
  🟢 +10.25 🟢 +3.65 🟢 +2.04 🟢 +1.7 🟢 +0.47 🟢 +0.94

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.17 43.03 10.94 12.32 12.22 8.01
  🟢 +0.04 🟢 +0.01 🟢 +0.01 🟢 +0.01 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less


## 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-production
Copy link
Contributor

codacy-production bot commented Feb 19, 2026

Codacy's Analysis Summary

0 new issue (≤ 0 minor issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

claudiacodacy and others added 3 commits February 19, 2026 21:47
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>
codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

claudiacodacy and others added 2 commits February 19, 2026 21:56
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>
codacy-production[bot]

This comment was marked as outdated.

Base automatically changed from new-dashboards to master February 20, 2026 10:08
codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

codacy-production[bot]

This comment was marked as outdated.

claudiacodacy and others added 3 commits February 20, 2026 14:35
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 14:37 Inactive
codacy-production[bot]

This comment was marked as outdated.

@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 14:45 Inactive
Copy link
Contributor

@codacy-production codacy-production bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ 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:

Suggested change
| **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ 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:

Suggested change
- 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.

Comment on lines +41 to +42
<div id="overall-quality-chart"></div>
### Code health and security
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ 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:

Suggested change
<div id="overall-quality-chart"></div>
### Code health and security
### Code health and security {#overall-quality-chart}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments