Skip to content

Commit 29fbc17

Browse files
committed
Deployed 603daf9 to . with MkDocs 1.6.1
1 parent 8cb9ec3 commit 29fbc17

5 files changed

Lines changed: 39 additions & 11 deletions

File tree

codacy-ai/codacy-ai/index.html

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<meta name="description" content="Documentation for the Codacy automated code review tool.">
1212

1313

14-
<meta http-equiv="last-modified" content="2025-12-10 11:33:17">
14+
<meta http-equiv="last-modified" content="2026-02-19 16:34:48">
1515

1616

1717
<link rel="canonical" href="https://docs.codacy.com/codacy-ai/codacy-ai/">
@@ -4917,7 +4917,7 @@ <h2 id="ai-features">AI Features<a class="headerlink" href="#ai-features" title=
49174917
<h3 id="ai-enhanced-comments">AI-enhanced comments<a class="headerlink" href="#ai-enhanced-comments" title="Permanent link">#</a></h3>
49184918
<p><em>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.</em></p>
49194919
<p>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.</p>
4920-
<p>More details about <a href="../../repositories-configure/integrations/github-integration/#ai-enhanced-comments">AI-enhanced comments here</a>.</p>
4920+
<p>More details about <a href="../../repositories-configure/integrations/github-integration/#ai-enhanced-comments">AI-enhanced comments here</a>.</p>
49214921
<p><strong>How to turn it on</strong></p>
49224922
<ol>
49234923
<li>Go to your organization or repository settings in Codacy.</li>
@@ -4943,7 +4943,7 @@ <h3 id="smart-false-positive-triage">Smart False Positive Triage<a class="header
49434943
</div>
49444944
<p><em>This feature leverages OpenAI models, and is strictly opt-in: you need to get in touch with us in order to enable it.</em></p>
49454945
<p>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.</p>
4946-
<p>More details about <a href="../../repositories/commits/#false-positive-issues">False Positives here</a>.</p>
4946+
<p>More details about <a href="../../repositories/commits/#false-positive-issues">False Positives here</a>.</p>
49474947
<p><strong>How to turn it on</strong></p>
49484948
<ol>
49494949
<li>Get in touch with your Customer Success Manager or with <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#115;&#117;&#112;&#112;&#111;&#114;&#116;&#64;&#99;&#111;&#100;&#97;&#99;&#121;&#46;&#99;&#111;&#109;">&#115;&#117;&#112;&#112;&#111;&#114;&#116;&#64;&#99;&#111;&#100;&#97;&#99;&#121;&#46;&#99;&#111;&#109;</a></li>
@@ -4963,15 +4963,39 @@ <h3 id="ai-reviewer">AI Reviewer<a class="headerlink" href="#ai-reviewer" title=
49634963
</div>
49644964
<p><em>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.</em></p>
49654965
<p>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.</p>
4966-
<p>More details about <a href="../../repositories-configure/integrations/github-integration/#ai-reviewer">AI Reviewer here</a>.</p>
4966+
<p>More details about <a href="../../repositories-configure/integrations/github-integration/#ai-reviewer">AI Reviewer here</a>.</p>
49674967
<p><strong>How to turn it on</strong></p>
49684968
<ol>
49694969
<li>Go to your organization or repository settings in Codacy.</li>
49704970
<li>Navigate to the "Integrations" or "AI features" section (depending on your Codacy plan and UI version).</li>
49714971
<li>Find "AI Reviewer", under "Status checks", and toggle the feature to "On" for the repository or organization scope you want to enable.</li>
49724972
<li>Save your changes. Once enabled, Codacy will start adding a Summary to your pull requests based on the AI-enriched reviews.</li>
4973-
<li>To request a PR Review from codacy, add a <strong><code>codacy-review</code></strong> label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.</li>
4973+
<li>To request a PR Review from Codacy, add a <strong><code>codacy-review</code></strong> label to your Pull Request. Codacy listens to the event and will publish the review as soon as it's ready.</li>
49744974
</ol>
4975+
<h4 id="custom-instructions">Custom Instructions<a class="headerlink" href="#custom-instructions" title="Permanent link">#</a></h4>
4976+
<p>To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences.</p>
4977+
<p>These instructions are specified in a <code>review.md</code> file in the <code>.codacy/instructions</code> directory of your repository.</p>
4978+
<p>You can kickstart this instructions file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt:</p>
4979+
<div class="highlight"><pre><span></span><code>Analyze this repository and generate a concise AI PR reviewer instruction file in Markdown.
4980+
4981+
The file should give a PR reviewer the essential context that won&#39;t be visible in a diff. Cover:
4982+
4983+
<span class="k">-</span><span class="w"> </span><span class="gs">**Purpose**</span>: What this repo does in 1-2 sentences.
4984+
<span class="k">-</span><span class="w"> </span><span class="gs">**Architecture**</span>: High-level structure, patterns used (e.g. MVC, event-driven, monorepo, etc.).
4985+
<span class="k">-</span><span class="w"> </span><span class="gs">**Folder structure**</span>: Key directories and what lives in each. Skip obvious ones.
4986+
<span class="k">-</span><span class="w"> </span><span class="gs">**Stack**</span>: Languages, frameworks, major libraries, and their roles.
4987+
<span class="k">-</span><span class="w"> </span><span class="gs">**Testing**</span>: Framework used, where tests live, what&#39;s expected to be tested.
4988+
<span class="k">-</span><span class="w"> </span><span class="gs">**Code style &amp; conventions**</span>: Naming, file organization, formatting tools, any patterns enforced.
4989+
<span class="k">-</span><span class="w"> </span><span class="gs">**PR-specific rules**</span>: Branch strategy, what a PR should/shouldn&#39;t include, migration rules, etc.
4990+
<span class="k">-</span><span class="w"> </span><span class="gs">**Common pitfalls**</span>: Things reviewers should flag — anti-patterns, known gotchas, areas that break easily.
4991+
<span class="k">-</span><span class="w"> </span><span class="gs">**Out of scope**</span>: Anything reviewers should explicitly ignore or not enforce.
4992+
4993+
Rules for the output:
4994+
<span class="k">-</span><span class="w"> </span>Output only the Markdown content, no preamble or explanation.
4995+
<span class="k">-</span><span class="w"> </span>Be concise. Every line should earn its place — no filler.
4996+
<span class="k">-</span><span class="w"> </span>Use short sections with bullet points. Avoid long prose.
4997+
<span class="k">-</span><span class="w"> </span>If something is not applicable or not inferable, omit the section entirely.
4998+
</code></pre></div>
49754999
<p><strong>Notes</strong></p>
49765000
<ul>
49775001
<li>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.</li>
@@ -5134,7 +5158,7 @@ <h3>Share your feedback 📢</h3>
51345158
<div class="md-source-date">
51355159
<small>
51365160

5137-
Last modified <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 10, 2025</span>
5161+
Last modified <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 19, 2026</span>
51385162

51395163
</small>
51405164
</div>

0 commit comments

Comments
 (0)