diff --git a/README.md b/README.md index 0cf883f..6e43ccf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ -TOC here +# Kodo AI Reviewer Action -[Action file](action.yml) \ No newline at end of file +An AI-powered automated code review tool that integrates into your CI/CD pipeline. It analyzes pull request changes and helps teams maintain high code quality — without the bottlenecks of manual review. + +## 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) +- [Action reference](action.yml)