From f42c2bb26bbf4d6a4edfc43e7e14687d0171d073 Mon Sep 17 00:00:00 2001 From: Alexey Efimchik Date: Thu, 12 Mar 2026 19:00:04 +0700 Subject: [PATCH] Updated README.md --- README.md | 9 +- .../ai-reviewer-output-format.md | 101 ------------------ docs/develoepr-guide/extension-of-rules.md | 41 ------- docs/develoepr-guide/faq-troubleshooting.md | 46 -------- docs/develoepr-guide/how-to-integrate.md | 45 -------- docs/devops-guide/reviewer-token.md | 37 ------- docs/user-guide/how-it-works.md | 40 ------- .../limitations-and-best-practices.md | 43 -------- docs/user-guide/what-is-kodo-reviewer.md | 37 ------- 9 files changed, 1 insertion(+), 398 deletions(-) delete mode 100644 docs/develoepr-guide/ai-reviewer-output-format.md delete mode 100644 docs/develoepr-guide/extension-of-rules.md delete mode 100644 docs/develoepr-guide/faq-troubleshooting.md delete mode 100644 docs/develoepr-guide/how-to-integrate.md delete mode 100644 docs/devops-guide/reviewer-token.md delete mode 100644 docs/user-guide/how-it-works.md delete mode 100644 docs/user-guide/limitations-and-best-practices.md delete mode 100644 docs/user-guide/what-is-kodo-reviewer.md diff --git a/README.md b/README.md index 6e43ccf..9078af6 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,5 @@ An AI-powered automated code review tool that integrates into your CI/CD pipelin ## Documentation -- [What is Kodo Reviewer?](docs/user-guide/what-is-kodo-reviewer.md) -- [How it works](docs/user-guide/how-it-works.md) -- [Limitations & best practices](docs/user-guide/limitations-and-best-practices.md) -- [CI/CD integration guide](docs/develoepr-guide/how-to-integrate.md) -- [Extending review rules](docs/develoepr-guide/extension-of-rules.md) -- [Review output format](docs/develoepr-guide/ai-reviewer-output-format.md) -- [Troubleshooting](docs/develoepr-guide/faq-troubleshooting.md) -- [Token setup](docs/devops-guide/reviewer-token.md) +- [Documentation](https://code.wynenterprise.io/kodo/reviewer/wiki) - [Action reference](action.yml) diff --git a/docs/develoepr-guide/ai-reviewer-output-format.md b/docs/develoepr-guide/ai-reviewer-output-format.md deleted file mode 100644 index d39cc43..0000000 --- a/docs/develoepr-guide/ai-reviewer-output-format.md +++ /dev/null @@ -1,101 +0,0 @@ -# AI Code Reviewer — Output Comment Format - -## 1. Summary Comment - -The summary comment is posted by the bot as a **top-level PR comment** after the review is complete. -It provides a high-level assessment of the entire diff. - -### Format - -``` -🔴 Code quality assessment: - -ℹī¸ Conclusion: - -❌ Merge: No - -✅ Merge: Yes -``` - -### Example - -> 🔴 Code quality assessment: Poor -> -> ℹī¸ Conclusion: The commit introduces a critical bug where `Stopwatch.StartNew()` is called twice on consecutive lines (lines 15–16 in `samples/AR/App.cs`). The duplicate assignment statement must be removed. -> -> ❌ Merge: No - blocking issue must be resolved first - -### Quality Levels - -| Badge | Label | Meaning | -|---|---|---| -| 🔴 | Poor | Blocking issues found, must not merge | -| 🟡 | Acceptable | Minor suggestions only | -| ✅ | Excellent | No issues found | - ---- - -## 2. Inline Comments - -Inline comments are posted **directly on the changed lines** in the diff. -They follow the [**Conventional Comments**](https://conventionalcomments.org/) approach to make severity and intent immediately clear. - -### Conventional Comments Format - -``` -