Add comprehensive documentation for Slack/Linear interrupt system #1175
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Document how real-time interrupts work during agent execution - Explain technical implementation with BaseRunner and TaskTimeline - Include examples for both Slack and Linear workflows - Add best practices and troubleshooting guidance - Update docs.json navigation to include new interrupts page
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. |
jayhack
reviewed
Jul 16, 2025
jayhack
reviewed
Jul 16, 2025
docs/capabilities/interrupts.mdx
Outdated
| Interrupt messages are structured as: | ||
|
|
||
| ```json | ||
| { |
Contributor
There was a problem hiding this comment.
Let's remove the technical implementation since htese are user-facing docs!
Contributor
Author
There was a problem hiding this comment.
Got it! I'll remove the technical implementation section since these are user-facing docs and update the Linear section with the mention requirements. Making those changes now! 📝
Contributor
Author
There was a problem hiding this comment.
✅ Updated the documentation with your feedback!
Changes made:
- Added clear warning that
@codegenmentions are required in Slack channels (but not in DMs) - Added note that Linear responds automatically unless other users are tagged
- Removed technical implementation section to keep it user-focused
- Updated best practices and troubleshooting to emphasize mention requirements
The docs now clearly explain when mentions are needed vs. when Codegen responds automatically. Much more user-friendly! 🎯
- Add clear warning that @codegen mentions are required in Slack channels (not DMs) - Add note that Linear responds automatically unless other users are tagged - Remove technical implementation section for user-facing docs - Update best practices and troubleshooting with mention requirements
jayhack
approved these changes
Jul 16, 2025
jayhack
approved these changes
Jul 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive documentation for Codegen's real-time interrupt system that allows users to send follow-up messages while the agent is actively working.
What's Added
New Documentation Page:
/docs/capabilities/interrupts.mdxKey sections covered:
BaseRunner,TaskTimeline, andLangGraphUpdated Navigation
capabilities/interruptsto the docs.json navigation structureTechnical Background
Based on analysis of the
cloudrepo implementation:app/agent_runners/base_runner.py): Handles interrupt detection and routingapp/agents/agent_run/task_timeline.py): Stores interrupt messages in theinterrupt_messagesqueueapp/agents/langgraph_utils/graph.py): Processes interrupts as[INTERRUPT]prefixed messagesapp/agents/langgraph_utils/memory_store.py): Manages interrupt message processing and indexingUser Impact
This documentation will help users understand:
The documentation is positioned in the "Capabilities" section alongside existing wake-up and general capabilities docs.
💻 View my work • 👤 Initiated by
Jay Hack• 💬 Initiated in #ext-notion-codegen • About Codegen