From c75f56170154b7b00cd759e1a3a9aff7b67eb9a5 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Thu, 6 Jul 2023 18:19:06 +0300 Subject: [PATCH] Add how it works section --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a89dad5..446025ad 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ It is powered by GPT-4, and is based on the [CodiumAI](https://github.com/Codium * [Quickstart](#Quickstart) * [Configuration](#Configuration) * [Usage and Tools](#usage-and-tools) +* [How it works](#how-it-works) * [Roadmap](#roadmap) * [Similar projects](#similar-projects) @@ -148,8 +149,6 @@ CodiumAI PR-Agent provides two types of interactions ("tools"): `"PR Reviewer"` - The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedbacks. - The "PR Q&A" tool answers free-text questions about the PR. - ![PR-Agent Tools](./pics/pr_agent_overview.png) - ### PR Reviewer Here is a quick overview of the different sub-tools of PR Reviewer: @@ -256,6 +255,11 @@ Example for extended suggestion: ``` --- +## How it works + ![PR-Agent Tools](./pics/pr_agent_overview.png) + +Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how pr-agent works. + ## Roadmap - [ ] Support open-source models, as a replacement for openai models. Note that a minimal requirement for each open-source model is to have 8k+ context, and good support for generating json as an output