Skip to content

Commit 97ec710

Browse files
authored
Further docs cleanup (#1256)
1 parent 35c841e commit 97ec710

File tree

8 files changed

+285
-186
lines changed

8 files changed

+285
-186
lines changed

docs/capabilities/capabilities.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Agent Capabilities"
3-
sidebarTitle: "Overview"
2+
title: "How Codegen Agents Work"
3+
sidebarTitle: "How it Works"
44
icon: "gear"
55
iconType: "solid"
66
---
@@ -28,7 +28,7 @@ graph TD
2828
A3[GitHub issue comment] --> A
2929
```
3030

31-
### 1. Trigger `@codegen` from Your Tools
31+
### 1. Users Trigger `@codegen` to Perform Tasks
3232

3333
Agents activate seamlessly from the platforms you already use:
3434

@@ -40,7 +40,7 @@ Agents activate seamlessly from the platforms you already use:
4040
- **[GitHub](/integrations/github)** - Comment on issues or PRs to request changes
4141
- **[API](http://localhost:3001/api-reference/agents/create-agent-run)** - Programmatically trigger agents for automated workflows
4242

43-
### 2. Work in Secure Sandboxes
43+
### 2. `@codegen` Performs Work in Secure Sandboxes
4444

4545
Once triggered, agents work in **[isolated sandbox environments](/sandboxes/overview)** where they can:
4646

@@ -49,7 +49,7 @@ Once triggered, agents work in **[isolated sandbox environments](/sandboxes/over
4949
- Make changes and validate them before committing
5050
- Access your repository context while maintaining security
5151

52-
### 3. Create and Manage Pull Requests
52+
### 3. Users Receive Completed Pull-Requests
5353

5454
Agents create **[GitHub pull requests](/integrations/github)** with:
5555

@@ -58,7 +58,7 @@ Agents create **[GitHub pull requests](/integrations/github)** with:
5858
- Clean, tested code ready for review
5959
- Proper commit messages following your conventions
6060

61-
### 4. Monitor and Auto-fix Issues
61+
### 4. Agents Monitor and Auto-fix PR Issues
6262

6363
The **[Checks Auto-fixer](/capabilities/checks-autofixer)** ensures quality by:
6464

@@ -67,7 +67,7 @@ The **[Checks Auto-fixer](/capabilities/checks-autofixer)** ensures quality by:
6767
- Pushing targeted fixes to resolve issues
6868
- Retrying up to 3 times before escalating to humans
6969

70-
### 5. Respond to Follow-ups
70+
### 5. Agents Respond to Follow-ups
7171

7272
Agents remain active to handle questions and refinements:
7373

docs/capabilities/claude-code.mdx

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
title: "Claude Code Integration"
3+
sidebarTitle: "Claude Code"
4+
icon: "code"
5+
---
6+
7+
Claude Code brings the power of Anthropic's coding assistant directly into your development workflow through Codegen. Whether you're running Claude locally or in the cloud, Codegen provides the infrastructure to enhance your AI coding experience with telemetry, integrations, and seamless deployment options.
8+
9+
<Frame>
10+
<video
11+
controls
12+
src="https://res.cloudinary.com/dbikr6pew/video/upload/v1757996504/Claude_Code_Integration_coe5sm.mp4"
13+
className="aspect-[3340/2160]"
14+
/>
15+
</Frame>
16+
17+
## Cloud Logging for Local Sessions
18+
19+
Every local Claude Code session is automatically logged to the cloud through the Codegen CLI. This seamless integration means your local development gains enterprise-grade observability without any extra configuration.
20+
21+
When you run Claude through `codegen`, you get:
22+
23+
- **Persistent history** across all your local Claude sessions
24+
- **Searchable conversations** accessible from any device
25+
- **Team visibility** into AI-assisted development patterns
26+
- **Audit trails** for compliance and debugging
27+
28+
<Note>
29+
Sessions appear instantly at [codegen.com/agents](https://codegen.com/agents),
30+
making it easy to share context with teammates or continue work from another
31+
machine.
32+
</Note>
33+
34+
## Connect Claude Code to Codegen Tools
35+
36+
Claude Code running through Codegen automatically gains access to all your connected integrations via MCP (Model Context Protocol). This transforms Claude from a coding assistant into a full development platform orchestrator.
37+
38+
Your existing Codegen integrations work seamlessly:
39+
40+
- **Slack** - Send updates and coordinate with your team
41+
- **Linear/Jira** - Update tickets and track progress
42+
- **GitHub** - Create PRs and manage repositories
43+
- **Databases** - Query and modify data safely
44+
- **Custom tools** - Any MCP server you've configured
45+
46+
No additional setup required - if it's connected to Codegen, Claude can use it.
47+
48+
<Tip>
49+
MCP integration means Claude can perform complex workflows like "When tests
50+
fail, create a Linear ticket and notify the team on Slack" - all in a single
51+
command.
52+
</Tip>
53+
54+
## Run Background Agents from your Terminal
55+
56+
Keep your terminal free while Claude handles long-running tasks. Background agents run asynchronously, perfect for automation that doesn't need constant supervision.
57+
58+
## Remote Sandbox Execution
59+
60+
Configure Claude Code as your default agent to run in Codegen's secure cloud sandboxes. This provides consistent, scalable environments for all your AI-assisted development.
61+
62+
<Card
63+
title="Set Claude Code as Default"
64+
icon="toggle-on"
65+
href="https://codegen.com/settings/model"
66+
>
67+
Enable Claude Code mode to run all agents in secure sandboxes with full
68+
integration support.
69+
</Card>
70+
71+
Remote execution benefits:
72+
73+
- **Consistent environments** across your team
74+
- **Pre-configured tools** and dependencies
75+
- **Scalable compute** for resource-intensive tasks
76+
- **Security isolation** from your local machine
77+
78+
## Getting Started
79+
80+
### Local Claude with Cloud Benefits
81+
82+
Get up and running in three simple steps:
83+
84+
1. Install the Codegen CLI:
85+
86+
```bash
87+
uv tool install codegen
88+
```
89+
90+
2. Authenticate with your account:
91+
92+
```bash
93+
codegen login
94+
```
95+
96+
3. Run Claude with full telemetry:
97+
```bash
98+
codegen claude "Help me refactor this authentication module"
99+
```
100+
101+
Your session immediately appears in the cloud with full integration access.
102+
103+
<Tip>
104+
The first time you run `codegen claude`, it will download the Claude Code
105+
binary. Subsequent runs start instantly.
106+
</Tip>
107+
108+
## Analytics and Insights
109+
110+
Transform your Claude Code usage into actionable intelligence. The analytics dashboard provides deep insights into how AI is transforming your development workflow.
111+
112+
Track key metrics:
113+
114+
- **Token usage** to understand costs and optimize prompts
115+
- **Task completion rates** and success patterns
116+
- **Integration usage** showing which tools Claude uses most
117+
- **Team adoption** identifying power users and best practices
118+
119+
Access detailed analytics at [codegen.com/analytics](https://codegen.com/analytics).
120+
121+
<Tip>
122+
Use analytics to identify repetitive tasks that could be automated with
123+
background agents, maximizing your team's productivity gains.
124+
</Tip>
125+
126+
## What's Next
127+
128+
Claude Code integration is just the beginning. We're actively working on:
129+
130+
- OpenAI Codex support for GPT-4 workflows
131+
- Gemini CLI integration for Google's models
132+
- Enhanced MCP protocol features
133+
- Custom model deployment options
134+
135+
Join our [community Slack](https://community.codegen.com) to stay updated and share your Claude Code workflows with other developers.

docs/capabilities/pr-review.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: "PR Review"
44
icon: "microscope"
55
---
66

7-
Codegen provides a configurable AI code review feature similar to CodeRabbit, Graphite, or Greptile as a first-class feature.
7+
Codegen provides AI code review as a first-class supported feature.
88

99
<Frame>
1010
<video
@@ -24,7 +24,9 @@ Codegen provides a configurable AI code review feature similar to CodeRabbit, Gr
2424

2525
## How It Works
2626

27-
When you open a PR or push new commits, Codegen agents analyze the changes and provide:
27+
When PR review is enabled on a repo, a Codegen agent will spin up to leave a detailed review.
28+
29+
This includes:
2830

2931
- **Inline comments** on specific lines with actionable feedback
3032
- **Security scanning** for vulnerabilities and unsafe patterns
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "Triggering Codegen"
3+
sidebarTitle: "Triggering Agents"
4+
icon: "play"
5+
---
6+
7+
Codegen is designed to work where you work. Trigger agents from your existing tools and they'll respond right where the conversation started.
8+
9+
## Trigger Methods
10+
11+
### From Your Tools
12+
13+
- **[Slack](/integrations/slack)** - Mention `@codegen` in any channel or DM
14+
- **[Linear](/integrations/linear)** - Assign issues to Codegen or mention in comments
15+
- **[Jira](/integrations/jira)** - Assign issues to Codegen or `@mention` in comments
16+
- **[ClickUp](/integrations/clickup)** - Assign tasks to Codegen or mention in comments
17+
- **[Monday.com](/integrations/monday)** - Assign items to Codegen or mention in comments
18+
- **[GitHub](/integrations/github)** - Comment on PRs or issues with `@codegen-agent`
19+
20+
### From Codegen
21+
22+
- **[Web UI](https://codegen.com/new)** - Start a new agent run directly from the dashboard
23+
- **[CLI](/introduction/cli)** - Run `codegen agent create "your task"` from your terminal
24+
- **[API](/api-reference/agents/create-agent-run)** - Trigger programmatically for automated workflows
25+
26+
## How Agent Context Works
27+
28+
### One Agent Per Context
29+
30+
Each context gets its own dedicated agent:
31+
32+
- **Slack** - Each thread is a separate agent. Follow-up messages in the same thread route to the same agent
33+
- **Linear/Jira/ClickUp/Monday** - Each ticket is a separate agent. All comments on that ticket go to the same agent
34+
- **GitHub** - Each issue or PR is a separate agent. All comments stay with the same agent
35+
36+
### Shared Context with PRs
37+
38+
When an agent creates a PR:
39+
40+
- The agent **always monitors its own PR** and responds to comments
41+
- Agents triggered from tickets (Linear, Jira, etc.) share context between the ticket and any PRs they create
42+
- Follow-up requests on either the ticket or PR route to the same agent
43+
- **Automatically fixes broken tests** - When CI checks fail, the agent wakes up and pushes fix commits
44+
45+
<Note>
46+
This means you can start a conversation in Linear, have the agent create a PR,
47+
then continue the discussion on either platform - it's all the same agent with
48+
full context.
49+
</Note>
50+
51+
<Tip>
52+
Follow-up messages always go to the same agent. Whether you're continuing a
53+
Slack thread, commenting on a ticket, or reviewing a PR - the agent maintains
54+
full conversation history.
55+
</Tip>
56+
57+
Learn more about automatic test fixing in the **[Checks Auto-fixer](/capabilities/checks-autofixer)** documentation.
58+
59+
## All Agents Created Equal
60+
61+
No matter where you trigger from, your request:
62+
63+
1. Routes to a dedicated agent for that context
64+
2. Runs in secure [sandboxes](/sandboxes/overview)
65+
3. Has access to all your [integrations](/integrations/integrations)
66+
4. Creates trackable runs visible at [codegen.com/agents](https://codegen.com/agents)
67+
68+
## Automatic Triggers
69+
70+
Codegen supports certain automated triggers as first-class citizens. These activate without manual intervention to maintain code quality:
71+
72+
- **[Checks Auto-fixer](/capabilities/checks-autofixer)** - Automatically fixes failing CI checks on agent PRs
73+
- **[PR Review](/capabilities/pr-review)** - Provides instant code review feedback on all PRs
74+
75+
<Note>
76+
These automations work alongside manual triggers. An agent fixing broken tests
77+
can still respond to comments on its PR or the original ticket that triggered
78+
it.
79+
</Note>
80+
81+
## Learn More
82+
83+
<CardGroup cols={2}>
84+
<Card
85+
title="Configure Integrations"
86+
icon="plug"
87+
href="/integrations/integrations"
88+
>
89+
Set up GitHub, Slack, and other tools
90+
</Card>
91+
92+
<Card title="CLI Documentation" icon="terminal" href="/introduction/cli">
93+
Trigger agents from your terminal
94+
</Card>
95+
<Card title="API Reference" icon="code" href="/api-reference/overview">
96+
Build custom workflows and automations
97+
</Card>
98+
</CardGroup>

docs/docs.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,21 @@
1717
"group": "Overview",
1818
"pages": [
1919
"introduction/overview",
20-
"introduction/prompting",
2120
"introduction/support",
2221
"introduction/community",
2322
"introduction/about",
23+
"introduction/prompting",
2424
"introduction/faq"
2525
]
2626
},
2727
{
28-
"group": "Capabilities",
28+
"group": "Guides",
2929
"pages": [
3030
"capabilities/capabilities",
31+
"capabilities/triggering-codegen",
3132
"capabilities/checks-autofixer",
3233
"capabilities/pr-review",
34+
"capabilities/claude-code",
3335
"capabilities/analytics",
3436
"introduction/cli",
3537
"introduction/sdk"
@@ -41,7 +43,6 @@
4143
"settings/settings",
4244
"settings/repo-rules",
4345
"settings/model-configuration",
44-
"settings/claude-code",
4546
"settings/agent-behavior",
4647
"settings/agent-permissions",
4748
"settings/team-roles",

docs/integrations/clickup.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ icon: "feather"
66

77
import { COMMUNITY_SLACK_URL } from "/snippets/links.mdx";
88

9-
Integrate Codegen with your ClickUp workspace to enable AI-powered task creation and project management. Codegen can create tasks, update statuses, manage dependencies, and coordinate development workflows across your team.
9+
Codegen supports ClickUp as a first-class integration. Assign issues, create issues, perform triage and more.
10+
11+
<Frame>
12+
<video
13+
controls
14+
src="https://res.cloudinary.com/dbikr6pew/video/upload/v1758064133/ClickUp_ysxp5s.mp4"
15+
className="aspect-[3340/2160]"
16+
/>
17+
</Frame>
1018

1119
## Installation
1220

0 commit comments

Comments
 (0)