Skip to content

Commit 14c9764

Browse files
authored
Docs update including videos (#1244)
1 parent c3f65c0 commit 14c9764

File tree

22 files changed

+1037
-170
lines changed

22 files changed

+1037
-170
lines changed

docs/capabilities/analytics.mdx

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "Agent Analytics"
3+
sidebarTitle: "Analytics"
4+
icon: "chart-line"
5+
---
6+
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.
8+
9+
## Key Metrics
10+
11+
Track the metrics that matter most for your development workflow:
12+
13+
- **Pull Request Analytics** - Monitor code merged, review velocity, and contributor activity
14+
- **Agent Tool Usage** - See which tools agents use most frequently and their success rates
15+
- **Cost Analysis** - Track spending across different models, agents, and time periods
16+
- **Performance Insights** - Analyze agent response times and task completion rates
17+
- **Team Activity** - Understand how different team members interact with agents
18+
19+
## Features
20+
21+
### Pull Request Tracking
22+
23+
- **Merge velocity** - Track how quickly PRs are created and merged
24+
- **Author activity** - See contributor patterns and productivity trends
25+
- **Status monitoring** - Monitor PR states and resolution times
26+
27+
### Detailed Filtering
28+
29+
- **Date range selection** - Analyze data over custom time periods
30+
- **User-specific views** - Filter by individual team members
31+
- **Status filtering** - Focus on specific PR states or outcomes
32+
- **Interactive charts** - Explore data with dynamic visualizations
33+
34+
### Real-time Insights
35+
36+
- **Live dashboards** - Get up-to-date metrics on agent activity
37+
- **Trend analysis** - Identify patterns in agent usage and effectiveness
38+
- **Cost optimization** - Make informed decisions about model selection and usage
39+
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+
52+
## Use Cases
53+
54+
**Performance Optimization**
55+
56+
- Identify which agents and tools provide the best ROI
57+
- Optimize model selection based on cost and performance data
58+
- Track improvement in development velocity over time
59+
60+
**Team Insights**
61+
62+
- Understand how different team members leverage AI assistance
63+
- Identify opportunities for increased agent adoption
64+
- Monitor the impact of agents on overall productivity
65+
66+
**Cost Management**
67+
68+
- Track spending across different LLM providers and models
69+
- Identify high-cost operations and optimize usage patterns
70+
- Budget and forecast AI assistance costs
71+
72+
<Tip>
73+
Use analytics to continuously optimize your agent workflows and demonstrate
74+
the value of AI assistance to your organization.
75+
</Tip>
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
title: "Check Suite Auto-fixer"
3+
sidebarTitle: "Checks Auto-fixer"
4+
icon: "bell"
5+
---
6+
7+
When GitHub checks fail on a Codegen PR, Codegen agents will automatically "wake up", analyze the failure, and push fix commit.
8+
9+
<video
10+
controls
11+
src="https://res.cloudinary.com/dbikr6pew/video/upload/v1757875834/4-fixing-checks_aagrki.mp4"
12+
className="w-full aspect-[3456/2160] rounded-sm"
13+
/>
14+
15+
This intelligent system monitors CI status and proactively resolves issues without manual intervention.
16+
17+
<Card
18+
title="Configure Check Suite Auto-fixer"
19+
icon="rocket"
20+
href="https://codegen.com/settings/checks-autofixer"
21+
>
22+
Configure globally at the organization level or customize settings per
23+
repository. Enterprise plans can adjust retry limits for optimal performance.
24+
</Card>
25+
26+
<Tip>
27+
Codegen will try to fix broken checks 3 times before "tapping out" by default.
28+
Enterprise customers can customize the retry count per check or per
29+
repository.
30+
</Tip>
31+
32+
## How Checks Auto-Fixer Works
33+
34+
Codegen continuously monitors your pull requests and automatically responds to check failures:
35+
36+
- **Automatic Detection:** Monitors GitHub check runs and CI status in real-time
37+
- **Intelligent Analysis:** Analyzes build logs, test failures, and error messages to understand root causes
38+
- **Targeted Fixes:** Generates specific code changes to resolve the identified issues
39+
- **Persistent Retry:** Will attempt to fix issues up to 3 times per PR
40+
41+
## What Triggers Auto-Fixing
42+
43+
Check auto-fixing activates when:
44+
45+
- **CI Checks Fail:** Any GitHub check run reports a failure status
46+
- **Build Errors:** Compilation, linting, or build process failures
47+
- **Test Failures:** Unit tests, integration tests, or automated test suites fail
48+
- **Code Quality Issues:** Static analysis tools report violations or warnings
49+
50+
## The Auto-Fix Process
51+
52+
When Codegen auto-fixes a failing PR, it follows this process:
53+
54+
1. **Detect Failure:** Monitor check status and identify when builds break
55+
2. **Analyze Logs:** Grep through CI logs to understand specific failure points
56+
3. **Generate Solution:** Create targeted code changes to resolve identified issues
57+
4. **Apply Fix:** Automatically commit fixes to the same PR branch
58+
5. **Re-validate:** Monitor the new check run to ensure the fix was successful
59+
60+
## Retry Logic
61+
62+
Codegen implements intelligent retry behavior:
63+
64+
- **Default: 3 attempts** per PR to resolve failing checks
65+
- **Enterprise customization** - Enterprise customers can configure retry limits:
66+
- Set global defaults at the organization level
67+
- Override per repository in repository settings
68+
- Customize retry counts per individual check type
69+
- **Progressive analysis** - each retry incorporates learnings from previous attempts
70+
- **Failure escalation** - when retry limit is reached, the issue is flagged for human review
71+
72+
## Configuration Options
73+
74+
The Checks Auto-Fixer can be configured at multiple levels:
75+
76+
### Organization Level
77+
78+
- **Global settings** - Configure default behavior for all repositories
79+
- **Available to all plans** - Enable/disable the feature organization-wide
80+
- **Access via** - Organization Settings → Checks Auto-Fixer
81+
82+
### Repository Level
83+
84+
- **Per-repo overrides** - Customize settings for specific repositories
85+
- **Individual check control** - Enable/disable monitoring per check type
86+
- **Custom instructions** - Provide specific guidance for handling each check
87+
- **Access via** - Repository Settings → Checks Auto-Fixer
88+
89+
### Enterprise Features
90+
91+
- **Custom retry limits** - Set retry counts globally, per repository, or per check type
92+
- **Advanced monitoring** - Granular control over which checks to monitor
93+
- **Priority handling** - Configure high-priority checks for immediate processing
94+
95+
## GitHub Integration
96+
97+
The auto-fix system integrates deeply with GitHub:
98+
99+
- **Check Run Annotations:** Creates detailed feedback with line-specific suggestions
100+
- **PR Comments:** Adds contextual suggestions and explanations
101+
- **Auto-Fix Actions:** Provides one-click fix buttons in the GitHub UI
102+
- **Status Updates:** Real-time updates on fix progress and results
103+
104+
<Note>
105+
Checks Auto-Fixer only activates for repositories where Codegen has write
106+
access and the feature is enabled. It respects your repository permissions and
107+
team workflows.
108+
</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/capabilities/pr-review.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: "PR Review Agent"
3+
sidebarTitle: "PR Review"
4+
icon: "eye"
5+
---
6+
7+
Codegen provides a configurable AI code review feature similar to CodeRabbit, Graphite, or Greptile as a first-class feature.
8+
9+
<Card
10+
title="Configure PR Reviews"
11+
icon="eye"
12+
href="https://codegen.com/settings/review"
13+
>
14+
Set up PR review at the organization level, then customize per repository.
15+
</Card>
16+
17+
## How It Works
18+
19+
When you open a PR or push new commits, Codegen agents analyze the changes and provide:
20+
21+
- **Inline comments** on specific lines with actionable feedback
22+
- **Security scanning** for vulnerabilities and unsafe patterns
23+
- **Code quality** suggestions for maintainability and best practices
24+
- **Architectural feedback** on design patterns and structure
25+
26+
## Configuration
27+
28+
Configure PR reviews at two levels:
29+
30+
### Organization Settings
31+
32+
Set global defaults and organization-wide review rules at [Organization Settings → PR Review](https://codegen.com/settings/review).
33+
34+
### Repository Settings
35+
36+
Override settings and add repository-specific rules at **Repository Settings → Review**.
37+
38+
Repository rules are combined with organization rules for comprehensive coverage. You can:
39+
40+
- Enable/disable PR reviews for the repository
41+
- Add custom review guidelines specific to the codebase
42+
- Define language-specific requirements
43+
- Set repository-specific coding standards
44+
45+
<Tip>
46+
Start with organization-level settings, then customize individual repositories
47+
as needed.
48+
</Tip>
49+
50+
<Note>
51+
PR reviews require read access to your repository. Enable the feature at both
52+
organization and repository levels to activate reviews.
53+
</Note>

docs/capabilities/wake-up.mdx

Lines changed: 0 additions & 67 deletions
This file was deleted.

docs/docs.json

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717
"group": "Overview",
1818
"pages": [
1919
"introduction/overview",
20-
"introduction/api",
21-
"introduction/cli",
2220
"introduction/prompting",
2321
"introduction/community",
2422
"introduction/about",
@@ -27,23 +25,42 @@
2725
},
2826
{
2927
"group": "Capabilities",
30-
"pages": ["capabilities/capabilities", "capabilities/wake-up"]
28+
"pages": [
29+
"capabilities/capabilities",
30+
"capabilities/checks-autofixer",
31+
"capabilities/pr-review",
32+
"capabilities/analytics",
33+
"introduction/cli",
34+
"introduction/sdk"
35+
]
36+
},
37+
{
38+
"group": "Settings",
39+
"pages": [
40+
"settings/settings",
41+
"settings/repo-rules",
42+
"settings/model-configuration",
43+
"settings/agent-behavior",
44+
"settings/agent-permissions"
45+
]
3146
},
3247
{
3348
"group": "Integrations",
3449
"pages": [
50+
"integrations/integrations",
3551
"integrations/github",
3652
"integrations/slack",
3753
"integrations/linear",
3854
"integrations/notion",
3955
"integrations/figma",
56+
"integrations/jira",
57+
"integrations/clickup",
58+
"integrations/monday",
59+
"integrations/sentry",
4060
"integrations/circleci",
4161
"integrations/web-search",
4262
"integrations/postgres",
43-
{
44-
"group": "integrations/mcp",
45-
"name": "Remote MCP Server"
46-
}
63+
"integrations/mcp-servers"
4764
]
4865
},
4966
{
@@ -56,10 +73,6 @@
5673
"sandboxes/editor",
5774
"sandboxes/web-preview"
5875
]
59-
},
60-
{
61-
"group": "Settings",
62-
"pages": ["settings/repo-rules", "settings/model-configuration"]
6376
}
6477
]
6578
},

0 commit comments

Comments
 (0)