Skip to content

Commit 29e8ba8

Browse files
docs: adding links + descriptions to ai codacy section (#2534)
* adding links + descriptions * add → symbols to links * funcionality notes on AI Reviewer docs * fix typos + grammar * Apply suggestions from codacy's code review 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>
1 parent d5ec2b0 commit 29e8ba8

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

docs/codacy-ai/codacy-ai.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,27 @@ Codacy AI utilizes only enterprise-grade instances of OpenAI and Google Gemini s
1010

1111
### AI-enhanced comments
1212

13+
_This feature leverages OpenAI models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it._
14+
1315
AI-enhanced comments are optional, machine-generated suggestions that appear directly in pull requests and review threads. They use Codacy's AI to provide concise issue summaries, remediation suggestions, and links to relevant documentation — helping reviewers and authors quickly understand and fix problems.
1416

15-
This feature leverages OpenAI models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
17+
More details about [AI-enhanced comments here →](../repositories-configure/integrations/github-integration.md#ai-enhanced-comments).
1618

17-
How to turn it on
19+
**How to turn it on**
1820

1921
1. Go to your organization or repository settings in Codacy.
2022
2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).
2123
3. Find "AI-enhanced comments" and toggle the feature to "On" for the repository or organization scope you want to enable.
2224
4. Optionally configure which repositories, branches, or severity levels should receive AI comments to reduce noise.
2325
5. Save your changes. Once enabled, Codacy will start adding AI-enhanced comments to new pull requests and code reviews according to the configured scope.
2426

25-
Notes
27+
**Notes**
2628

2729
- Administrators can enable or disable the feature at organization or repository level.
2830
- Enabling the feature may be subject to plan limitations and governance controls; check your Codacy subscription and admin permissions.
2931
- Users can still ignore or dismiss individual AI comments during code review.
3032

31-
- Data usage and privacy
33+
**Data usage and privacy**
3234

3335
- To generate an AI-enhanced comment, Codacy only processes the specific issue context: the issue line plus up to ten lines before and ten lines after that line. No additional repository data is sent or used.
3436
- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
@@ -41,34 +43,42 @@ Notes
4143
end="<!--paid-feature-business-end-->"
4244
%}
4345

44-
This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it.
46+
_This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it._
47+
48+
Codacy False Positive triage analyzes results on a commit basis to give you visibility into issues that may be false positives (based on their context). During triage, each issue is given a confidence score along with an explanation. When the confidence level falls below a defined threshold, the issue is then flagged as an AI false positive and surfaced for manual review. You can evaluate potential false positives during a pull request in app or on any Codacy page where issues appear. These issues can be ignored or marked as Not a false positive.
49+
50+
More details about [False Positives here →](../repositories/commits.md#false-positive-issues).
4551

46-
How to turn it on
52+
**How to turn it on**
4753

4854
1. Get in touch with your Customer Success Manager or with <support@codacy.com>
4955

50-
Notes
56+
**Notes**
5157

5258
- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
5359
- To detect a Possible False Positive, Codacy only processes the specific issue context: one request per file with issues. No additional repository data is sent or used.
5460
- Prompts are neither stored nor visible by anyone
5561

56-
### PR Reviewer
62+
### AI Reviewer
5763

5864
!!! note
59-
PR Reviewer is currently only available on GitHub, for all Team and Business plans.
65+
AI Reviewer is currently only available on GitHub, for all Team and Business plans.
66+
67+
_This feature leverages Google Gemini models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it._
68+
69+
The AI Reviewer combines the reliability of deterministic, rule-based static code analysis with the power of AI. It draws in the necessary context from source code and PR metadata to ensure the business intent matches the technical outcome, and can catch logic gaps that conventional scanners (and human reviewers) often miss.
6070

61-
This feature leverages Google Gemini models, and is strictly opt-in: it will only run on repositories or projects where a repository admin has enabled it.
71+
More details about [AI Reviewer here →](../repositories-configure/integrations/github-integration.md#ai-reviewer).
6272

63-
How to turn it on
73+
**How to turn it on**
6474

6575
1. Go to your organization or repository settings in Codacy.
6676
2. Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).
6777
3. Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable.
68-
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests with of the information used to provide the AI-enriched reviews.
78+
4. Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews.
6979
5. To request a PR Review from codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.
7080

71-
Notes
81+
**Notes**
7282

7383
- Codacy does not use your code, repository contents, or comments to train external AI models. No customer code or review text is incorporated into model training.
7484
- To enrich the review, the git diff of the Pull Request as well as some related files' contents can be sent as context. No data is stored on our side, or used to train any models.

docs/repositories-configure/integrations/github-integration.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,20 @@ Adds a report to your pull requests showing whether your pull requests and cover
3232

3333
### AI Reviewer
3434

35+
!!! note
36+
This feature is only supported on GitHub.
37+
38+
If you choose to enable the AI Reviewer, consider disabling the AI-enhanced comments, as it may duplicate any comments on Codacy issues you receive.
39+
3540
The AI Reviewer combines the reliability of deterministic, rule-based static code analysis with the power of AI. It draws in the necessary context from source code and PR metadata to ensure the business intent matches the technical outcome, and can catch logic gaps that conventional scanners (and human reviewers) often miss.
3641

3742
It provides feedback on missing or weak tests, complex or duplicated code, and keeps security concerns up to date. Beyond that, it adds contextual insights about whether the changes follow the requirements, business rules, and logic used in the project.
3843

44+
This setting can be enabled at a repository or organization level. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews. To request a PR Review from Codacy, add a **`codacy-review`** label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.
45+
46+
3947
![AI Reviewer on Github](images/github-integration-ai-reviewer.png)
4048

41-
!!! note
42-
This feature is only supported on GitHub.
4349

4450
### Issue annotations
4551

0 commit comments

Comments
 (0)