docs

Author: msukkari

docs/docs.json

@@ -43,6 +43,13 @@
                             }
                         ]
                     },
+                    {
+                        "group": "Agents",
+                        "pages": [
+                            "docs/agents/overview",
+                            "docs/agents/review-agent"
+                        ]
+                    },
                     {
                         "group": "More",
                         "pages": [

docs/docs/agents/overview.mdx

@@ -0,0 +1,17 @@
+---
+title: "Agents Overview"
+sidebarTitle: "Overview"
+---
+
+<Note>
+Have an idea for an agent that we haven't built? Submit a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/feature-requests) on our GitHub
+</Note>
+
+Agents are automations that leverage the code indexed on Sourcebot to perform a specific task. Once you've setup Sourcebot, check out the
+guides below to configure additional agents.
+
+<CardGroup cols={2}>
+    <Card horizontal title="Review Agent" icon="gear" href="/docs/agents/review-agent">
+        An AI agent that reviews your PRs to identify issues
+    </Card>
+</CardGroup>

docs/docs/agents/review-agent.mdx

@@ -0,0 +1,57 @@
+---
+title: AI Code Review Agent
+sidebarTitle: AI Code Review Agent
+---
+
+<Note>
+This agent sends data to OpenAI (through an API key you supply) to perform code reviews. This data includes code from the PR being reviewed, as well as additional relevant context from your
+codebase that the agent may fetch to perform the review.
+</Note>
+
+This agent provides codebase-aware reviews for your PRs. For each diff, this agent fetches relevant context from Sourcebot and feeds it into an LLM for a detailed review of your changes.
+
+The AI Code Review Agent is open source and packaged in [Sourcebot](https://github.com/sourcebot-dev/sourcebot). To get started using this agent, [deploy Sourcebot](http://localhost:3001/self-hosting/overview)
+and then follow the configuration instructions below.
+
+![AI Code Review Agent Example](/images/review_agent_example.png)
+
+# Configure
+
+This agent currently only supports reviewing GitHub PRs. You configure the agent by creating a GitHub app, installing it into your GitHub organization, and then giving your app info to Sourcebot.
+
+Before you get started, make sure you have an OpenAPI account that you can create an OpenAPI key with.
+
+<Steps>
+    <Step title="Register a GitHub app">
+        Follow the official GitHub guide for [registering a GitHub app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
+
+        - GitHub App name: You can make this whatever you want (ex. Sourcebot Review Agent)
+        - Homepage URL: You can make this whatever you want (ex. https://www.sourcebot.dev/)
+        - Webhook URL (**IMPORTANT**): You must set this to point to your Sourcebot deployment at /api/webhook (ex. https://sourcebot.aperture.com/api/webhook). Your Sourcebot deployment must be able to accept requests from GitHub
+        (either github.com or your self-hosted enterprise server) for this to work. If you're running Sourcebot locally, you can [use smee](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#step-2-get-a-webhook-proxy-url) to [forward webhooks](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#step-6-start-your-server) to you local deployment.
+        - Permissions
+            - Pull requests: Read
+            - Contents: Read
+        - Events:
+            - Pull request
+    </Step>
+    <Step title="Install the GitHub app in your organization">
+        Navigate to your new GitHub app's page and press `Install`. You can find this in your [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings). 
+        
+        Select the repositories that you want to install the app into.
+    </Step>
+    <Step title="Configure the environment variables in Sourcebot">
+        Sourcebot requires the following environment variables to begin reviewing PRs through your new GitHub app:
+
+        - `GITHUB_APP_ID`: The client ID of your GitHub app. Can be found in your [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings)
+        - `GITHUB_APP_WEBHOOK_SECRET`: A random webhook secret that you've set in your [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings). This can be anything (ex. `python -c "import secrets; print(secrets.token_hex(10))"` to generate a random secret)
+        - `GITHUB_APP_PRIVATE_KEY_PATH`: The path to your app's private key. You can generate a private key file for your app in the [app settings](https://docs.github.com/en/apps/creating-github-apps/writing-code-for-a-github-app/quickstart#navigate-to-your-app-settings)
+        ![GitHub App Private Key](/images/github_app_private_key.png)
+        - `OPENAI_API_KEY`: Your OpenAI API key
+    </Step>
+    <Step title="Verify configuration">
+        Navigate to the agents page by pressing `Agents` in the Sourcebot nav menu. If you've configured your environment variables you'll see the following:
+
+        ![Review Agent Configured](/images/review_agent_configured.png)
+    </Step>
+</Steps>

docs/images/github_app_private_key.png

@@ -1,7 +1,6 @@
 import Link from "next/link";
 import { NavigationMenu } from "../components/navigationMenu";
 import { FaCogs } from "react-icons/fa";
-import { MdRocketLaunch } from "react-icons/md";
 import { env } from "@/env.mjs";
 
 const agents = [

docs/images/review_agent_configured.png

@@ -59,6 +59,13 @@ export const NavigationMenu = async ({
                                     </NavigationMenuLink>
                                 </Link>
                             </NavigationMenuItem>
+                            <NavigationMenuItem>
+                                <Link href={`/${domain}/agents`} legacyBehavior passHref>
+                                    <NavigationMenuLink className={navigationMenuTriggerStyle()}>
+                                        Agents
+                                    </NavigationMenuLink>
+                                </Link>
+                            </NavigationMenuItem>
                             <NavigationMenuItem>
                                 <Link href={`/${domain}/repos`} legacyBehavior passHref>
                                     <NavigationMenuLink className={navigationMenuTriggerStyle()}>