Skip to content

Commit 6bcdb0a

Browse files
authored
Further docs fixes (#1247)
1 parent 14c9764 commit 6bcdb0a

File tree

11 files changed

+300
-136
lines changed

11 files changed

+300
-136
lines changed

docs/capabilities/analytics.mdx

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
---
2-
title: "Agent Analytics"
2+
title: "Analytics"
33
sidebarTitle: "Analytics"
4-
icon: "chart-line"
4+
icon: "chart-column"
55
---
66

7-
Get comprehensive insights into your agent activity with detailed analytics on tool usage, costs, performance, and team productivity. Codegen provides fine-grained visibility into how agents are working across your organization.
7+
What impact are code agents having on your codebase (and your finances) today? How can you better deploy them across your org?
8+
Codegen Analytics was built to answer these questions and more.
9+
10+
<Frame caption="Cost analytics on codegen.com/analytics">
11+
<img src="/images/cost-breakdown.png" alt="Analyze cost breakdown" />
12+
</Frame>
13+
14+
<Card
15+
title="View Analytics Dashboard"
16+
icon="chart-line"
17+
href="https://codegen.com/analytics"
18+
>
19+
Access detailed analytics on agent performance, costs, and team productivity.
20+
</Card>
821

922
## Key Metrics
1023

@@ -37,18 +50,6 @@ Track the metrics that matter most for your development workflow:
3750
- **Trend analysis** - Identify patterns in agent usage and effectiveness
3851
- **Cost optimization** - Make informed decisions about model selection and usage
3952

40-
## Access Analytics
41-
42-
View your organization's analytics dashboard to get started:
43-
44-
<Card
45-
title="View Analytics Dashboard"
46-
icon="chart-line"
47-
href="https://codegen.com/analytics"
48-
>
49-
Access detailed analytics on agent performance, costs, and team productivity.
50-
</Card>
51-
5253
## Use Cases
5354

5455
**Performance Optimization**

docs/capabilities/capabilities.mdx

Lines changed: 124 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -5,59 +5,127 @@ icon: "gear"
55
iconType: "solid"
66
---
77

8-
Codegen agents come equipped with versatile tools designed to integrate seamlessly into your development workflow.
9-
10-
## Integrated Tool Suites
11-
12-
Deep integrations with the tools your team already uses:
13-
14-
<CardGroup cols={3}>
15-
<Card title="GitHub" icon="github" href="/integrations/github">
16-
Create and manage pull requests, automated code reviews, run CI/CD
17-
workflows, sync repository changes.
18-
</Card>
19-
<Card title="Linear" icon="file-lines" href="/integrations/linear">
20-
Create and update issues automatically, track development progress, link
21-
code changes to tickets.
22-
</Card>
23-
<Card title="Slack" icon="slack" href="/integrations/slack">
24-
Chat directly in channels, get real-time notifications, share code snippets
25-
and updates.
26-
</Card>
27-
<Card title="Notion" icon="books" href="/integrations/notion">
28-
Access workspace documentation, update pages and databases, sync development
29-
information.
30-
</Card>
31-
<Card title="Figma" icon="figma" href="/integrations/figma">
32-
Access design specifications, extract design assets, convert designs to
33-
code.
34-
</Card>
35-
<Card title="CircleCI" icon="circle-play" href="/integrations/circleci">
36-
View broken checks, analyze build logs, automatically fix failing PRs and
37-
wake up on failures.
38-
</Card>
39-
<Card title="PostgreSQL" icon="postgres" href="/integrations/postgres">
40-
Execute SQL queries directly, analyze database schemas, generate data
41-
insights.
42-
</Card>
43-
</CardGroup>
44-
45-
## Core Features
46-
47-
Fundamental capabilities for comprehensive development support:
48-
49-
<CardGroup cols={2}>
50-
<Card title="Code Execution Sandbox" icon="box" href="/sandboxes/overview">
51-
Safely run code, install dependencies, and test changes in an isolated
52-
environment.
53-
</Card>
54-
<Card title="Web Search" icon="globe" href="/integrations/web-search">
55-
Access up-to-date information, research libraries, find documentation
56-
online.
57-
</Card>
58-
</CardGroup>
59-
60-
<Note>
61-
These capabilities allow Codegen agents to handle complex tasks across
62-
multiple systems, just like a human developer.
63-
</Note>
8+
Codegen agents follow a simple but powerful workflow: they're triggered from your existing tools, work in secure sandboxes to implement changes, create pull requests, and then monitor and fix any issues that arise. This creates a seamless development experience that integrates naturally with your team's existing processes.
9+
10+
## The Agent Happy Path
11+
12+
Here's how Codegen agents work from start to finish:
13+
14+
```mermaid
15+
graph TD
16+
A[Trigger from Integration] --> B[Work in Remote Sandbox]
17+
B --> C[Create Pull Request]
18+
C --> D[Monitor CI Checks]
19+
D --> E[Auto-fix Failed Checks]
20+
E --> D
21+
D --> D1[All checks pass ✓]
22+
D1 --> G[Ready for Review]
23+
G --> F[Respond to Follow-up Questions]
24+
F --> G
25+
26+
A1[Slack @mention] --> A
27+
A2[Linear issue assignment] --> A
28+
A3[GitHub issue comment] --> A
29+
```
30+
31+
### 1. Trigger `@codegen` from Your Tools
32+
33+
Agents activate seamlessly from the platforms you already use:
34+
35+
- **[Slack](/integrations/slack)** - Tag `@codegen` in any channel or send a direct message
36+
- **[Linear](/integrations/linear)** - Assign an issue to Codegen or mention it in comments
37+
- **[Jira](/integrations/jira)** - Assign an issue to Codegen or mention it in comments
38+
- **[ClickUp](/integrations/clickup)** - Assign a task to Codegen or mention it in comments
39+
- **[Monday.com](/integrations/monday)** - Assign an item to Codegen or mention it in comments
40+
- **[GitHub](/integrations/github)** - Comment on issues or PRs to request changes
41+
- **[API](http://localhost:3001/api-reference/agents/create-agent-run)** - Programmatically trigger agents for automated workflows
42+
43+
### 2. Work in Secure Sandboxes
44+
45+
Once triggered, agents work in **[isolated sandbox environments](/sandboxes/overview)** where they can:
46+
47+
- Execute code safely without affecting your systems
48+
- Install dependencies and run tests
49+
- Make changes and validate them before committing
50+
- Access your repository context while maintaining security
51+
52+
### 3. Create and Manage Pull Requests
53+
54+
Agents create **[GitHub pull requests](/integrations/github)** with:
55+
56+
- Detailed descriptions explaining the changes
57+
- Links back to the original request (Linear issue, Slack thread, etc.)
58+
- Clean, tested code ready for review
59+
- Proper commit messages following your conventions
60+
61+
### 4. Monitor and Auto-fix Issues
62+
63+
The **[Checks Auto-fixer](/capabilities/checks-autofixer)** ensures quality by:
64+
65+
- Monitoring CI/CD pipeline results in real-time
66+
- Automatically analyzing build failures and test errors
67+
- Pushing targeted fixes to resolve issues
68+
- Retrying up to 3 times before escalating to humans
69+
70+
### 5. Respond to Follow-ups
71+
72+
Agents remain active to handle questions and refinements:
73+
74+
- Respond to PR review comments with additional changes
75+
- Answer questions in the original Slack thread or Linear issue
76+
- Make adjustments based on feedback from team members
77+
- Provide explanations of their implementation decisions
78+
79+
## Configuration & Customization
80+
81+
Codegen agents can be customized to match your team's specific workflows and requirements:
82+
83+
### Model Selection
84+
85+
Choose from leading AI models and configure custom API keys to optimize performance and cost for your organization.
86+
87+
<Card
88+
title="Model Configuration"
89+
icon="brain-circuit"
90+
href="/settings/model-configuration"
91+
>
92+
Select LLM providers, configure custom API keys, and optimize performance
93+
settings.
94+
</Card>
95+
96+
### Agent Behavior
97+
98+
Control how agents interact with users and approach code modifications to ensure they align with your team's preferences.
99+
100+
<Card title="Agent Behavior" icon="robot" href="/settings/agent-behavior">
101+
Configure plan proposals, GitHub mention requirements, and interaction
102+
patterns.
103+
</Card>
104+
105+
### Security & Permissions
106+
107+
Define what actions agents are allowed to perform across your organization with fine-grained permission controls.
108+
109+
<Card
110+
title="Agent Permissions"
111+
icon="shield-check"
112+
href="/settings/agent-permissions"
113+
>
114+
Control PR creation, rules detection, and enforce security policies like
115+
signed commits.
116+
</Card>
117+
118+
<Tip>
119+
Start with conservative settings and gradually expand agent capabilities as
120+
your team becomes comfortable with AI assistance.
121+
</Tip>
122+
123+
## Learn More
124+
125+
Dive deeper into specific capabilities:
126+
127+
- **[Get started with the overview](/introduction/overview)** - Complete introduction to Codegen
128+
- **[Explore integrations](/integrations/integrations)** - See all available platforms and tools
129+
- **[Understand sandboxes](/sandboxes/overview)** - Learn about the secure execution environment
130+
- **[Configure settings](/settings/settings)** - Customize agent behavior and permissions
131+
- **[View analytics](/capabilities/analytics)** - Monitor agent performance and impact

docs/capabilities/checks-autofixer.mdx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: "Checks Auto-fixer"
44
icon: "bell"
55
---
66

7-
When GitHub checks fail on a Codegen PR, Codegen agents will automatically "wake up", analyze the failure, and push fix commit.
7+
When GitHub checks fail on a Codegen PR, Codegen agents will automatically "wake up", analyze the failure, and push fix commits.
88

99
<video
1010
controls
@@ -106,10 +106,3 @@ The auto-fix system integrates deeply with GitHub:
106106
access and the feature is enabled. It respects your repository permissions and
107107
team workflows.
108108
</Note>
109-
110-
## Benefits
111-
112-
- **Reduced Context Switching:** No need to manually investigate and fix CI failures
113-
- **Faster Iteration:** PRs get fixed automatically, keeping development velocity high
114-
- **Learning from Failures:** Each fix improves Codegen's understanding of your codebase
115-
- **24/7 Monitoring:** Works around the clock to keep your PRs in good shape

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
"settings/repo-rules",
4242
"settings/model-configuration",
4343
"settings/agent-behavior",
44-
"settings/agent-permissions"
44+
"settings/agent-permissions",
45+
"settings/team-roles"
4546
]
4647
},
4748
{

docs/images/cost-breakdown.png

376 KB
Loading

docs/introduction/cli.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@ icon: "terminal"
55
iconType: "solid"
66
---
77

8-
# Codegen CLI Manual
8+
The `codegen` CLI allows users to run and interact with agents from the terminal.
99

10-
Welcome to the Codegen CLI documentation. This guide covers all available commands and their usage patterns.
10+
<iframe
11+
className="w-full aspect-video rounded-xl"
12+
src="https://youtube.com/embed/sQ2XOonma0w"
13+
title="YouTube video player"
14+
frameBorder="0"
15+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
16+
allowFullScreen
17+
></iframe>
1118

1219
## Installation
1320

@@ -34,11 +41,13 @@ codegen login
3441
**Description:** Create a new agent run with a prompt, fetch an existing agent run by ID, or pull PR branch.
3542

3643
**Usage Patterns:**
44+
3745
- **Create run:** `codegen agent --prompt "Your prompt"`
3846
- **Get run JSON:** `codegen agent --id 123 --json`
3947
- **Pull PR branch:** `codegen agent --id 123 pull`
4048

4149
**Options:**
50+
4251
- `--prompt, -p TEXT` The prompt to send to the agent (mutually exclusive with --id unless using create)
4352
- `--id INT` Agent run ID to fetch or pull
4453
- `--json` Output raw JSON response when fetching (flag)
@@ -47,6 +56,7 @@ codegen login
4756
- `--repo-id INT` Repository ID to use for this agent run (optional)
4857

4958
**Positional Actions:**
59+
5060
- `pull` Pull the PR branch associated with an agent run (requires --id)
5161

5262
---
@@ -56,10 +66,12 @@ codegen login
5666
**Description:** List and manage agent runs.
5767

5868
**Usage Patterns:**
69+
5970
- **List runs:** `codegen agents list`
6071
- **Get run details:** `codegen agents get 123`
6172

6273
**Options:**
74+
6375
- `--org-id INT` Organization ID (defaults to CODEGEN_ORG_ID/REPOSITORY_ORG_ID or auto-detect)
6476
- `--limit INT` Maximum number of runs to return (default: 10)
6577
- `--json` Output raw JSON response (flag)
@@ -71,10 +83,12 @@ codegen login
7183
**Description:** Store authentication token.
7284

7385
**Usage Patterns:**
86+
7487
- **Interactive login:** `codegen login`
7588
- **Token login:** `codegen login --token YOUR_API_TOKEN`
7689

7790
**Options:**
91+
7892
- `--token TEXT` API token to store
7993
- `--no-verify` Skip token verification (flag)
8094

@@ -85,6 +99,7 @@ codegen login
8599
**Description:** Clear stored authentication token.
86100

87101
**Usage Pattern:**
102+
88103
- `codegen logout`
89104

90105
---
@@ -94,11 +109,13 @@ codegen login
94109
**Description:** Manage and switch between organizations.
95110

96111
**Usage Patterns:**
112+
97113
- **List organizations:** `codegen org list`
98114
- **Switch organization:** `codegen org switch ORG_ID`
99115
- **Get current organization:** `codegen org current`
100116

101117
**Options:**
118+
102119
- `--json` Output raw JSON response (flag)
103120

104121
---
@@ -108,11 +125,13 @@ codegen login
108125
**Description:** Manage repository configuration and environment variables.
109126

110127
**Usage Patterns:**
128+
111129
- **List repositories:** `codegen repo list`
112130
- **Configure repository:** `codegen repo config REPO_NAME`
113131
- **Get repository details:** `codegen repo get REPO_ID`
114132

115133
**Options:**
134+
116135
- `--org-id INT` Organization ID (defaults to CODEGEN_ORG_ID or auto-detect)
117136
- `--json` Output raw JSON response (flag)
118137

docs/introduction/overview.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: "robot"
55
iconType: "solid"
66
---
77

8-
Codegen provides intelligent AI agents designed to seamlessly integrate into your existing developer workflows.
8+
Codegen helps you run frontier code agents at scale. It provides the necessary building blocks (sandboxes, integrations, telemetry) for successful enterprise code agent deployments across thousands of teams today.
99

1010
Think of it as an AI coworker that can understand and solve coding challenges, access your codebase instantly, and interact directly with your development tools.
1111

@@ -109,3 +109,20 @@ Codegen is SOC 2 Type II certified, ensuring your code and data are handled with
109109
Learn how to use Codegen for common code transformation tasks.
110110
</Card>
111111
</CardGroup>
112+
113+
## Learn More
114+
115+
<CardGroup cols={2}>
116+
<Card
117+
title="Join the Community"
118+
icon="people-group"
119+
href="/introduction/community"
120+
>
121+
Connect with other developers, get help, and share your experiences in our
122+
active Slack workspace.
123+
</Card>
124+
<Card title="About Codegen" icon="building" href="/introduction/about">
125+
Learn about our mission to build fully-autonomous software engineering and
126+
meet the team.
127+
</Card>
128+
</CardGroup>

0 commit comments

Comments
 (0)