Skip to content

Commit 77a1387

Browse files
add more docs
1 parent 6eb4fbf commit 77a1387

7 files changed

Lines changed: 47 additions & 3 deletions
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# FAQs
2+
3+
## Is Guardrails only for AI-generated code?
4+
No — while it's AI-aware, it scans all code in real-time, regardless of how it was written.
5+
6+
## How is Guardrails different from Codacy’s traditional analysis?
7+
Guardrails is IDE-first and real-time. It complements Codacy’s platform analysis by catching issues earlier in the development cycle.
8+
9+
## Does Guardrails work offline?
10+
Yes, local scanning via Codacy CLI works offline. API-based features (like querying metrics) require connectivity.
11+
12+
## What sort of security and quality standards can I enforce with Codacy Guardrails?
13+
14+
## Is my data secure?
15+
16+
## When I change some analysis configuration in the UI, should I clean the cache to use guardrails?
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# How to use
2+
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Limitations
2+
3+
## Limitations of Windows WSL
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Local Code Analysis
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Overview
2+
3+
Codacy Guardrails is a brand new way of enforcing code security and quality standards for AI-generated code, built into the free Codacy IDE Extension for VSCode, Copilot, Cursor, and Windsurf. Guardrails helps developers ship safer, cleaner AI code by applying best practices and blocking insecure patterns – while the code is being generated.
4+
5+
Besides real-time AI code scanning, Guardrails users can now prompt all their Codacy findings, without ever leaving the AI chat panel inside their IDE.
6+
New to Codacy Guardrails? [Watch the Guardrails live demo](https://youtu.be/uVyRWnnJu-0?feature=shared), or [download the free Codacy Extension](docs.codacy.com) and try it out yourself!
7+
8+
## Compatibility / Requirements
9+
10+
### Supported Operating Systems / Versions
11+
### Supported IDE's
12+
13+
## How to install the Codacy Extension
14+
15+
### Visual Studio Code
16+
### Cursor
17+
### Windsurf
18+
19+
## How to install MCP Server

docs/codacy-guardrails/requirements.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

mkdocs.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,12 @@ nav:
562562
- getting-started/supported-languages-and-tools.md
563563
- getting-started/which-permissions-does-codacy-need-from-my-account.md
564564
- getting-started/adding-a-codacy-badge.md
565-
- Codacy Guardrails:
566-
- codacy-guardrails/requirements.md
565+
- Codacy Guardrails (IDE Extension):
566+
- codacy-guardrails/codacy-guardrails-overview.md
567+
- codacy-guardrails/codacy-guardrails-local-analysis.md
568+
- codacy-guardrails/codacy-guardrails-how-to-use.md
569+
- codacy-guardrails/codacy-guardrails-limitations.md
570+
- codacy-guardrails/codacy-guardrails-faq.md
567571
- Repositories on Codacy Quality:
568572
- repositories/repository-dashboard.md
569573
- repositories/commits.md

0 commit comments

Comments
 (0)