Added docs folder
This commit is contained in:
37
docs/user-guide/what-is-kodo-reviewer.md
Normal file
37
docs/user-guide/what-is-kodo-reviewer.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Kodo AI Reviewer
|
||||
|
||||
## 🤖 What is it?
|
||||
|
||||
Kodo AI Reviewer is an AI-powered automated code review tool. It integrates into your CI/CD pipeline, analyzes pull request changes, and helps teams maintain high code quality — without the bottlenecks of manual review.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Why use it?
|
||||
|
||||
| | Feature | What it means for you |
|
||||
|---|---|---|
|
||||
| ⏱️ | **Saves time** | Automates the routine review process so engineers focus on what matters |
|
||||
| 📋 | **Single source of truth** | Consistent, reproducible feedback — no human bias or mood swings |
|
||||
| 📈 | **Better code quality** | Catches style issues, logic flaws, and potential bugs comprehensively |
|
||||
| 🕐 | **Always available** | Reviews code 24/7 — no waiting for a teammate to free up |
|
||||
| 🔧 | **Highly customizable** | Extend built-in rules or create entirely new checks for your needs |
|
||||
| 💬 | **Interactive** | Ask follow-up questions and get instant responses to your comments |
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Where does it work?
|
||||
|
||||
Kodo AI Reviewer works directly inside your **CI/CD pipeline** — it runs automatically on every pull request, no extra setup required beyond the initial configuration.
|
||||
|
||||
---
|
||||
|
||||
## ✨ How does it work?
|
||||
|
||||
### 🔁 CI/CD Flow
|
||||
|
||||
When a pull request is opened or updated, Kodo kicks in automatically:
|
||||
|
||||
1. 📥 **Reads the environment** — loads your action configuration and prepares the review context
|
||||
2. 🔍 **Analyzes your changes** — scans the diff for issues, improvements, and code quality signals
|
||||
3. 💬 **Leaves comments** — posts inline feedback and a summary conclusion on the PR
|
||||
4. 🗣️ *(Optional)* **Responds to you** — mention the predefined tag in any comment and Kodo will reply directly to your question or request
|
||||
Reference in New Issue
Block a user