feat: add codacy usage docs [LK-1802]

[joanasteodoro]

👀 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]

Overall readability score: 52.85 (🟢 +0.03)

File	Readability
codacy-usage.md	58.94 (-)

View detailed metrics

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

File	Readability	FRE	GF	ARI	CLI	DCRS
codacy-usage.md	58.94	42.82	10.67	12.7	11.66	6.73
	-	-	-	-	-	-

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	52.85	42.71	11	12.74	12.63	8
	🟢 +0.03	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0.01

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

[codacy-production]

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]

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.

[Copilot]

Pull request overview

This PR adds documentation for the Codacy usage dashboard feature. It includes a new documentation page describing how organizations can monitor their Codacy adoption, along with three supporting images showing various dashboard views.

Key Changes:

• Added navigation entries for "Codacy usage" and "AI Risk Hub" pages in the organization section
• Created comprehensive documentation explaining the Codacy usage dashboard with four main sections
• Added three PNG images illustrating dashboard components

Reviewed changes

Copilot reviewed 2 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
mkdocs.yml	Added navigation entries for codacy-usage.md and ai-risk-hub.md
docs/organizations/codacyusage.md	New documentation page explaining Codacy usage dashboard features and sections
docs/organizations/images/top-repositories.png	Screenshot showing top repositories list
docs/organizations/images/repositories-evolution.png	Screenshot showing repository evolution chart
docs/organizations/images/repositories-distribution.png	Screenshot showing repository distribution chart

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 7 changed files in this pull request and generated 3 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 7 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[LipeGheno]

Hey Joana! Here is a suggestion for the copy. Please let me know if they make sense:

Codacy Usage

The Codacy usage dashboard offers an overview of your organization's adoption of Codacy. You can filter the displayed list of repositories by their Git provider, as well as by their gate and coverage information within Codacy. Additionally, you can filter by selecting specific repositories or by using the segments that you have set up.

To view the Codacy usage dashboard:

• Select an organization from the top navigation bar.
• On the organization overview page, click the Codacy usage tab.

Repositories

This chart displays the distribution of repositories in Codacy and repositories that are not. The doughnut chart also details the breakdown of Codacy repositories based on their configuration: those without quality gates, without coverage, without either gates or coverage, and those with both gates and coverage. Users can interact with the doughnut chart or the numerical data to filter the results. Applying a filter will also affect the repositories displayed in the evolution chart and the results will appear in the "Top repositories" list.

Repositories evolution

This chart shows the trend of repositories in your organization over time, considering the filters applied. You can hover over the chart to see the number of repositories on a specific date. You can also click on the chart to filter results.

Merged pull requests

This chart displays the number of pull requests merged in your repositories, categorizing them as either analyzed or not analyzed.
Analyzed PRs are further broken down into three sub-categories:

• Passing Gates: Merged PRs that successfully passed all quality gates.
• Failing Gates: Merged PRs that failed one or more quality gates.
• Without Gates: Merged PRs where no quality gates were configured or applied.

Interacting with the chart allows you to filter the data, with the resulting repositories displayed in the "Top repositories" list.

Top repositories

The list shows a maximum of 10 repositories from your Git provider. You can use filters to display repositories that are not yet in Codacy, or repositories that are already in Codacy. For repositories in Codacy, the list can also group them by specific metrics such as gates, coverage, and merged pull request information.