Skip to content

docs: clarify CI trigger behavior in wake-up documentation #1123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Jun 3, 2025

This PR updates the wake-up documentation to clarify two key aspects of how Codegen responds to CI failures:

Changes Made

  • Immediate Response: Added info box explaining that Codegen starts working as soon as the first check fails, rather than waiting for all checks to complete
  • Single Agent Per Commit: Added info box explaining that all failed checks from the same commit are handled by one agent for consistent fixes

Why This Matters

The previous documentation didn't clearly explain the timing behavior, which led to customer confusion about when Codegen would start working on failed checks. These additions make the customer-facing docs more intuitive and remove technical jargon while providing clear expectations.

Files Changed

  • docs/capabilities/wake-up.mdx - Added two info boxes in the "What Triggers Wake Up" section

💻 View my workAbout Codegen

- Add info box explaining Codegen starts immediately when first check fails
- Add info box explaining all failed checks from same commit route to single agent
- Makes customer-facing docs more intuitive and clear about timing behavior
Copy link
Contributor Author

codegen-sh bot commented Jun 3, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

- Removed stray </initial_code> tag at end of file
- This was causing test failures in the CI pipeline
Copy link
Contributor Author

codegen-sh bot commented Jun 3, 2025

✅ Fixed the failing check in commit 0b78983.

The issue was a stray </initial_code> tag at the end of the docs/capabilities/wake-up.mdx file that was causing the documentation build to fail. I've removed this erroneous tag and pushed the fix to the PR branch.

The CI should now pass! 🚀

💻 View my work • React 👍 or 👎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants