diff --git a/Kodo-AI-Reviewer-%F0%9F%A4%96.md b/Kodo-AI-Reviewer.md similarity index 96% rename from Kodo-AI-Reviewer-%F0%9F%A4%96.md rename to Kodo-AI-Reviewer.md index 2c7e178..09852ae 100644 --- a/Kodo-AI-Reviewer-%F0%9F%A4%96.md +++ b/Kodo-AI-Reviewer.md @@ -1,54 +1,54 @@ -# 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 - ---- - -## 📚 Documentation by role - -### 👩‍💻 Developer -- [Code Review with Kodo](developer-guide/how-it-works) — how to trigger, skip, and interact with the reviewer -- [Review Output Format](developer-guide/ai-reviewer-output-format) — how to read summary comments, inline comments, and PR status -- [Limitations & Best Practices](developer-guide/limitations-and-best-practices) — what Kodo can't do and how to get the most out of it - -### 🧑‍🔧 Tech Lead -- [CI/CD Integration](techlead-guide/how-to-integrate) — how to add Kodo to your repository workflow -- [Custom Review Rules](techlead-guide/extension-of-rules) — how to extend the built-in rules with project-specific instructions -- [Troubleshooting](techlead-guide/faq-troubleshooting) — what to check when Kodo doesn't run - -### ⚙️ DevOps +# 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 + +--- + +## 📚 Documentation + +### 👩‍💻 Developer +- [Code Review with Kodo](developer-guide/how-it-works) — how to trigger, skip, and interact with the reviewer +- [Review Output Format](developer-guide/ai-reviewer-output-format) — how to read summary comments, inline comments, and PR status +- [Limitations & Best Practices](developer-guide/limitations-and-best-practices) — what Kodo can't do and how to get the most out of it + +### 🧑‍🔧 Tech Lead +- [CI/CD Integration](techlead-guide/how-to-integrate) — how to add Kodo to your repository workflow +- [Custom Review Rules](techlead-guide/extension-of-rules) — how to extend the built-in rules with project-specific instructions +- [Troubleshooting](techlead-guide/faq-troubleshooting) — what to check when Kodo doesn't run + +### ⚙️ DevOps - [Gitea Token Setup](devops-guide/reviewer-token) — how to generate the bot token and configure repository secrets \ No newline at end of file diff --git a/_Sidebar.md b/_Sidebar.md deleted file mode 100644 index d52d276..0000000 --- a/_Sidebar.md +++ /dev/null @@ -1,16 +0,0 @@ -## 🤖 Kodo AI Reviewer - -- [What is Kodo?](what-is-kodo-reviewer.md) - -### 👩‍💻 Developer -- [Code Review with Kodo](developer-guide/how-it-works.md) -- [Review Output Format](developer-guide/ai-reviewer-output-format.md) -- [Limitations & Best Practices](developer-guide/limitations-and-best-practices.md) - -### 🧑‍🔧 Tech Lead -- [CI/CD Integration](techlead-guide/how-to-integrate.md) -- [Custom Review Rules](techlead-guide/extension-of-rules.md) -- [Troubleshooting](techlead-guide/faq-troubleshooting.md) - -### ⚙️ DevOps -- [Gitea Token Setup](devops-guide/reviewer-token.md) diff --git a/developer-guide/ai-reviewer-output-format.md b/user-guide/ai-reviewer-output-format.md similarity index 100% rename from developer-guide/ai-reviewer-output-format.md rename to user-guide/ai-reviewer-output-format.md diff --git a/developer-guide/how-it-works.md b/user-guide/how-it-works.md similarity index 100% rename from developer-guide/how-it-works.md rename to user-guide/how-it-works.md diff --git a/developer-guide/limitations-and-best-practices.md b/user-guide/limitations-and-best-practices.md similarity index 100% rename from developer-guide/limitations-and-best-practices.md rename to user-guide/limitations-and-best-practices.md