Skip to content

Commit 678912f

Browse files
jayhackjayhack
authored
docs: added integrations docs (#1120)
Co-authored-by: jayhack <2548876+jayhack@users.noreply.github.com>
1 parent 7cb4205 commit 678912f

File tree

15 files changed

+445
-93
lines changed

15 files changed

+445
-93
lines changed

‎docs/capabilities/capabilities.mdx‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Agent Capabilities"
3+
sidebarTitle: "Overview"
4+
icon: "gear"
5+
iconType: "solid"
6+
---
7+
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>

‎docs/capabilities/wake-up.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: "Wake Up & Auto-Fix"
3+
sidebarTitle: "Wake Up"
4+
icon: "bell"
5+
---
6+
7+
When your GitHub checks fail, Codegen automatically wakes up to analyze the failures and fix your PR. This intelligent system monitors CI status and proactively resolves issues without manual intervention.
8+
9+
<Tip>Codegen will try to fix broken checks 3x before "tapping out"</Tip>
10+
11+
## How Wake Up Works
12+
13+
Codegen continuously monitors your pull requests and automatically responds to check failures:
14+
15+
- **Automatic Detection:** Monitors GitHub check runs and CI status in real-time
16+
- **Intelligent Analysis:** Analyzes build logs, test failures, and error messages to understand root causes
17+
- **Targeted Fixes:** Generates specific code changes to resolve the identified issues
18+
- **Persistent Retry:** Will attempt to fix issues up to 3 times per PR
19+
20+
## What Triggers Wake Up
21+
22+
Wake up activates when:
23+
24+
- **CI Checks Fail:** Any GitHub check run reports a failure status
25+
- **Build Errors:** Compilation, linting, or build process failures
26+
- **Test Failures:** Unit tests, integration tests, or automated test suites fail
27+
- **Code Quality Issues:** Static analysis tools report violations or warnings
28+
29+
## The Auto-Fix Process
30+
31+
When Codegen wakes up to fix a failing PR, it follows this process:
32+
33+
1. **Detect Failure:** Monitor check status and identify when builds break
34+
2. **Analyze Logs:** Grep through CI logs to understand specific failure points
35+
3. **Generate Solution:** Create targeted code changes to resolve identified issues
36+
4. **Apply Fix:** Automatically commit fixes to the same PR branch
37+
5. **Re-validate:** Monitor the new check run to ensure the fix was successful
38+
39+
## Retry Logic
40+
41+
Codegen implements intelligent retry behavior:
42+
43+
- **Up to 3 attempts** per PR to resolve failing checks
44+
- **Progressive analysis** - each retry incorporates learnings from previous attempts
45+
- **Failure escalation** - if 3 attempts fail, the issue is flagged for human review
46+
47+
## GitHub Integration
48+
49+
The wake-up system integrates deeply with GitHub:
50+
51+
- **Check Run Annotations:** Creates detailed feedback with line-specific suggestions
52+
- **PR Comments:** Adds contextual suggestions and explanations
53+
- **Auto-Fix Actions:** Provides one-click fix buttons in the GitHub UI
54+
- **Status Updates:** Real-time updates on fix progress and results
55+
56+
<Note>
57+
Wake up only activates for repositories where Codegen has write access and the
58+
feature is enabled. It respects your repository permissions and team
59+
workflows.
60+
</Note>
61+
62+
## Benefits
63+
64+
- **Reduced Context Switching:** No need to manually investigate and fix CI failures
65+
- **Faster Iteration:** PRs get fixed automatically, keeping development velocity high
66+
- **Learning from Failures:** Each fix improves Codegen's understanding of your codebase
67+
- **24/7 Monitoring:** Works around the clock to keep your PRs in good shape

‎docs/docs.json‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,29 @@
1414
"tab": "Documentation",
1515
"groups": [
1616
{
17-
"group": "Introduction",
17+
"group": "Overview",
1818
"pages": [
1919
"introduction/overview",
20-
"introduction/capabilities",
2120
"introduction/api",
2221
"introduction/prompting",
2322
"introduction/community",
2423
"introduction/about",
2524
"introduction/faq"
2625
]
2726
},
27+
{
28+
"group": "Capabilities",
29+
"pages": ["capabilities/capabilities", "capabilities/wake-up"]
30+
},
2831
{
2932
"group": "Integrations",
3033
"pages": [
34+
"integrations/github",
3135
"integrations/slack",
3236
"integrations/linear",
33-
"integrations/github",
37+
"integrations/notion",
38+
"integrations/figma",
39+
"integrations/circleci",
3440
"integrations/web-search",
3541
"integrations/postgres"
3642
]
@@ -40,20 +46,15 @@
4046
"pages": [
4147
"sandboxes/overview",
4248
"sandboxes/setup-commands",
43-
"sandboxes/base-image",
44-
"sandboxes/editor",
4549
"sandboxes/environment-variables",
50+
"sandboxes/secrets",
51+
"sandboxes/editor",
4652
"sandboxes/web-preview"
4753
]
4854
},
4955
{
5056
"group": "Settings",
51-
"pages": [
52-
"settings/agent-permissions",
53-
"settings/organization-rules",
54-
"settings/repo-rules",
55-
"settings/model-configuration"
56-
]
57+
"pages": ["settings/repo-rules", "settings/model-configuration"]
5758
}
5859
]
5960
},

‎docs/integrations/circleci.mdx‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "CircleCI Integration"
3+
sidebarTitle: "CircleCI"
4+
icon: "circle-play"
5+
---
6+
7+
Monitor and automatically fix failing CI checks with CircleCI integration. Codegen views check status, analyzes build logs, and automatically fixes issues when PRs fail. When Codegen creates a PR and checks fail, it will automatically wake up to investigate the logs and push fixes.
8+
9+
<Warning>
10+
CircleCI is currently available for enterprise customers. See
11+
[codegen.com/billing](https://codegen.com/billing) for more
12+
</Warning>
13+
14+
## Capabilities
15+
16+
The CircleCI integration enables intelligent check monitoring and automatic issue resolution:
17+
18+
- **View broken checks and failures** - Monitor CI check status and identify specific failure points
19+
- **Analyze build logs and error messages** - Grep through logs to understand root causes of failures
20+
- **Automatically fix failing PRs** - Push corrective changes when checks fail on Codegen-created PRs
21+
- **Wake up on check failures** - Automatically trigger when CI checks fail to investigate and resolve issues
22+
23+
## Permissions
24+
25+
The Codegen CircleCI integration requires the following permissions:
26+
27+
- **Read project information and settings** - Access pipeline configurations and project details
28+
- **View build history and logs** - Monitor pipeline execution and analyze failure logs
29+
- **Read test results and artifacts** - Access build outputs, test reports, and error details
30+
- **Access check status and details** - Monitor CI check results and failure information
31+
32+
<Note>
33+
Codegen operates in read-only mode for CircleCI - it monitors and analyzes but
34+
does not trigger builds or modify CI configurations.
35+
</Note>
36+
37+
## How Agents Use CircleCI
38+
39+
Agents leverage the CircleCI integration to:
40+
41+
- **Monitor Check Status:** Continuously watch for CI check failures on pull requests
42+
- **Analyze Failure Logs:** Grep through build logs to identify specific errors, test failures, or build issues
43+
- **Auto-Fix Issues:** When Codegen creates a PR and checks fail, it automatically investigates and pushes fixes
44+
- **Prevent Broken Merges:** Ensure code quality by resolving CI failures before merge
45+
46+
## Automatic Wake-Up Behavior
47+
48+
When Codegen creates a pull request and CircleCI checks fail, Codegen will automatically:
49+
50+
1. **Detect the failure** - Monitor check status and identify when builds break
51+
2. **Analyze the logs** - Grep through CircleCI logs to understand the specific failure
52+
3. **Generate fixes** - Create targeted code changes to resolve the identified issues
53+
4. **Push updates** - Automatically commit fixes to the same PR branch
54+
55+
This ensures that Codegen-created PRs maintain high quality and don't introduce breaking changes to your codebase.
56+
57+
## Installation
58+
59+
Connect your CircleCI account to Codegen to enable automatic check monitoring and issue resolution.
60+
61+
<Card
62+
title="Connect CircleCI Account"
63+
icon="circle-play"
64+
href="https://codegen.sh/integrations"
65+
>
66+
Authorize Codegen to view your CircleCI check results and build logs.
67+
</Card>
68+
69+
<Note>
70+
Ensure the agent has access to the specific CircleCI projects and
71+
organizations you want it to monitor.
72+
</Note>{" "}

‎docs/integrations/figma.mdx‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "Figma Integration"
3+
sidebarTitle: "Figma"
4+
icon: "figma"
5+
---
6+
7+
AI is one of the most valuable collaborators for front-end modifications, UI updates, messaging, and crafting the aesthetic of what you're building. Codegen can now do serious work on both implementation and contributing to your design documentation, bridging the gap between design and code seamlessly.
8+
9+
## Capabilities
10+
11+
The Figma integration enables seamless design-to-code workflows:
12+
13+
- **Access design specifications** - Read design files, components, and detailed specifications
14+
- **Extract design assets** - Pull images, icons, and visual elements for implementation
15+
- **Convert designs to code** - Transform design mockups into functional frontend code
16+
- **Sync design changes** - Stay updated with design iterations and modifications
17+
18+
## Permissions
19+
20+
The Codegen Figma integration requires the following permissions:
21+
22+
- **Read your profile and user information** - Access basic account details for authentication
23+
- **Access file contents, nodes, and editor data** - Read design files and component structures
24+
- **Read file metadata and version history** - Track design changes and version information
25+
- **View file comments and discussions** - Understand design context and feedback
26+
- **Access design variables and tokens** - Use consistent design system values
27+
- **Read published components and styles** - Access shared design system components
28+
- **Access team library content** - Use shared assets and design resources
29+
- **List projects and project files** - Navigate and organize design files
30+
31+
## How Agents Use Figma
32+
33+
Agents leverage the Figma integration to:
34+
35+
- **Analyze Designs:** Examine design files to understand layout, styling, and component structure
36+
- **Generate Code:** Convert Figma designs into HTML, CSS, React components, or other frontend code
37+
- **Extract Assets:** Pull icons, images, and other visual assets needed for implementation
38+
- **Maintain Design Systems:** Ensure code implementation follows design system guidelines and tokens
39+
40+
## Installation
41+
42+
Connect your Figma account to Codegen to enable design-to-code workflows.
43+
44+
<Card
45+
title="Connect Figma Account"
46+
icon="figma"
47+
href="https://codegen.sh/integrations/figma"
48+
>
49+
Authorize Codegen to access your Figma files and design resources.
50+
</Card>
51+
52+
<Note>
53+
The Figma integration requires feature flag access. Contact your team
54+
administrator to enable this integration.
55+
</Note>{" "}

‎docs/integrations/github.mdx‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,29 @@ sidebarTitle: "GitHub"
44
icon: "github"
55
---
66

7-
Connect Codegen to your GitHub repositories to enable agents to read code, create branches, commit changes, open pull requests, comment on issues, and more.
7+
GitHub is how Codegen accesses your repository contents and performs all git interactions. Codegen can create PRs from requests or issues, help resolve merge conflicts, conduct code reviews, search through your codebase, and handle the full spectrum of agentic coding workflows—everything flows through GitHub.
88

99
## Capabilities
1010

11-
Our GitHub integration grants Codegen agents both read and write access, allowing them to function like a member of your development team:
11+
The GitHub integration provides comprehensive development workflow capabilities:
1212

13-
- **Read Access:** Clone repositories, read file contents, inspect branches, view issues and PRs.
14-
- **Write Access:** Create branches, push commits, open/update pull requests, comment on PRs and issues, assign reviewers.
13+
- **Create and manage pull requests** - Generate, update, and manage PRs with detailed descriptions and context
14+
- **Automated code reviews and feedback** - Provide intelligent code analysis and suggestions
15+
- **Run checks and CI/CD workflows** - Execute automated testing and deployment processes
16+
- **Sync repository changes** - Keep repositories up-to-date and coordinate between branches
17+
18+
## Permissions
19+
20+
The Codegen GitHub integration requires the following permissions to function as a full development team member:
21+
22+
- **Read and write repository contents** - Access code, files, and repository structure
23+
- **Create and manage pull requests** - Generate, update, and merge pull requests
24+
- **Write status checks and CI/CD results** - Report on automated testing and deployment status
25+
- **Read and write issues and comments** - Interact with project issues and provide updates
26+
- **Read repository metadata and settings** - Access repository configuration and settings
27+
- **Read and write GitHub Actions workflows** - Manage automated workflows and CI/CD pipelines
28+
- **Read organization projects and members** - Access team structure and project organization
29+
- **Manage webhooks for real-time updates** - Enable real-time synchronization and notifications
1530

1631
## How Agents Use GitHub
1732

0 commit comments

Comments
 (0)