diff --git a/_Sidebar.md b/_Sidebar.md new file mode 100644 index 0000000..00937d2 --- /dev/null +++ b/_Sidebar.md @@ -0,0 +1,22 @@ +## 🤖 Kodo AI Reviewer + +- [What is Kodo?](what-is-kodo-reviewer) + +--- + +### 👩‍💻 Developer +- [Code Review with Kodo](developer-guide/how-it-works) +- [Review Output Format](developer-guide/ai-reviewer-output-format) +- [Limitations & Best Practices](developer-guide/limitations-and-best-practices) + +--- + +### 🧑‍🔧 Tech Lead +- [CI/CD Integration](techlead-guide/how-to-integrate) +- [Custom Review Rules](techlead-guide/extension-of-rules) +- [Troubleshooting](techlead-guide/faq-troubleshooting) + +--- + +### ⚙️ DevOps +- [Gitea Token Setup](devops-guide/reviewer-token) diff --git a/what-is-kodo-reviewer.md b/what-is-kodo-reviewer.md index d41e618..77f9bb3 100644 --- a/what-is-kodo-reviewer.md +++ b/what-is-kodo-reviewer.md @@ -34,4 +34,21 @@ 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 \ No newline at end of file +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 +- [Gitea Token Setup](devops-guide/reviewer-token) — how to generate the bot token and configure repository secrets \ No newline at end of file