Skip to content

Commit df69439

Browse files
jayhacktkucar
authored andcommitted
docs: codegen agent docs (#840)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed
1 parent 8e577f9 commit df69439

File tree

5 files changed

+519
-381
lines changed

5 files changed

+519
-381
lines changed

docs/gen/capabilities.mdx

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: "Capabilities"
3+
icon: "gear"
4+
---
5+
6+
Codegen is built on an [open-source library](/introduction/overiew.mdx) for code manipulation.
7+
8+
It combines "tools" for code editing with powerful integrations, including Github, Linear and Slack.
9+
10+
<Tip>
11+
Learn more about our open source [code agent implementation](/docs/tutorials/build-code-agent)
12+
</Tip>
13+
14+
## Communication Tools
15+
16+
- **SlackSendMessageTool**: Allows Codegen to send messages in Slack channels and threads, providing responses to your queries and sharing information with your team.
17+
18+
## GitHub Integration Tools
19+
20+
Codegen includes a comprehensive set of GitHub tools:
21+
22+
- **GithubCheckoutPRTool**: Checks out pull requests to your local environment for review and testing.
23+
24+
- **GithubCreatePRTool**: Creates new pull requests from your current branch, including title, description, and target branch.
25+
26+
- **GithubCreatePRCommentTool**: Adds comments to pull requests for feedback and team communication.
27+
28+
- **GithubCreatePRReviewCommentTool**: Provides inline comments on specific code changes within pull requests.
29+
30+
- **GithubEditPRTool**: Modifies existing pull requests, including updating titles, descriptions, and other metadata.
31+
32+
- **GithubSearchIssuesTool**: Searches for GitHub issues based on various criteria like status, assignee, or labels.
33+
34+
- **GithubViewPRTool**: Retrieves and displays information about specific pull requests.
35+
36+
- **GithubViewPRCheckTool**: Checks the status of CI/CD and other automated checks on pull requests.
37+
38+
- **GithubViewCommitHistoryTool**: Shows the commit history of a repository or specific branch.
39+
40+
- **GithubViewCommitTool**: Displays details about specific commits, including changes made.
41+
42+
## Linear Integration Tools (Optional)
43+
44+
For teams using Linear for project management, Codegen offers:
45+
46+
- **LinearGetIssueTool**: Retrieves details about specific Linear issues.
47+
48+
- **LinearGetIssueCommentsTool**: Fetches comments on Linear issues for context and history.
49+
50+
- **LinearCommentOnIssueTool**: Adds comments to Linear issues for team communication.
51+
52+
- **LinearSearchIssuesTool**: Searches for Linear issues based on various criteria.
53+
54+
- **LinearCreateIssueTool**: Creates new issues in Linear with appropriate metadata.
55+
56+
- **LinearGetTeamsTool**: Retrieves information about teams in your Linear organization.
57+
58+
## How Codegen Uses These Tools
59+
60+
Codegen's AI brain (powered by Claude 3.7 Sonnet) intelligently selects and combines these tools to:
61+
62+
1. Understand your requests through natural language in Slack
63+
2. Determine the most appropriate tools to fulfill your request
64+
3. Execute the necessary actions across GitHub, Linear, and your codebase
65+
4. Provide clear, helpful responses back in Slack
66+
67+
This seamless integration allows you to manage your entire development workflow through simple conversations, without having to switch between different platforms and interfaces.
68+
69+
## Getting Started
70+
71+
Ready to experience the power of Codegen? Check out our [Quickstart Guide](/docs/gen/quickstart) to set up Codegen for your team, and explore [Common Commands](/docs/gen/common-commands) to see how to interact with these tools through natural language.

docs/gen/faq.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Frequently Asked Questions"
3+
sidebarTitle: "FAQ"
4+
icon: "square-question"
5+
iconType: "solid"
6+
---
7+
8+
<AccordionGroup>
9+
<Accordion title="What model does Codegen use?" icon="code">
10+
Claude 3.7. Our code agent is roughly comparable with Claude Code.
11+
</Accordion>
12+
<Accordion title="Is this free?" icon="scale-balanced">
13+
Yes! For now. Get it while it's hot.
14+
</Accordion>
15+
<Accordion title="Where is my data stored?" icon="database">
16+
Codegen stores this data in their private cloud. We are SOC-2 compliant. [Learn more](/introduction/about)
17+
</Accordion>
18+
</AccordionGroup>

docs/gen/introduction.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Codegen: AI Development Assistant"
3+
sidebarTitle: "Introduction"
4+
icon: "lightbulb"
5+
---
6+
7+
Codegen is an intelligent code agent powered that seamlessly integrates with Slack, Github and Linear.
8+
9+
<Frame caption="Communicate with codegen via Slack">
10+
<img src="/images/codegen-bot-intro.png" />
11+
</Frame>
12+
13+
<Tip>
14+
Explore our [Capabilities](/docs/gen/capabilities) page to learn more about
15+
Codegen's full feature set and available tools!
16+
</Tip>
17+
18+
19+
# Installation
20+
21+
[Log in with GitHub](https://codegen.sh/start) to install Codegen and set up integrations.
22+
23+
<Card title="Get Started" href={"https://codegen.sh/start"} icon="Gear">
24+
Install codegen via OAuth with Github, Slack and Linear
25+
</Card>
26+
27+
# Common Queries
28+
29+
> *Edit repo X so that the user auth flow uses JWT*
30+
Modify the authentication flow in a specified repository to use JSON Web Tokens. This ensures secure and stateless authentication.
31+
32+
> *Show me the recent activity on my repo X*
33+
Display the latest commits, pull requests, and other activities in a specified repository. This helps you stay updated with ongoing changes.
34+
35+
> *Can you figure out why my tests are failing on `main`?*
36+
Analyze the test failures on the main branch to identify potential issues. This assists in maintaining code quality and stability.
37+
38+
> *Can you review my PR?*
39+
Perform a code review on a specified pull request, providing feedback and suggestions. This ensures code quality and adherence to best practices.
40+
41+
> *Do we have any tickets about Y?*
42+
Search for tickets related to a specific topic or issue. This helps in tracking and managing tasks effectively.
43+

docs/images/codegen-bot-intro.png

148 KB
Loading

0 commit comments

Comments
 (0)