Add comprehensive scope keys documentation #1122
Draft
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
![codegen-sh[bot]](https://avatars.githubusercontent.com/in/321279?s=60&v=4){kind=small}
- Created detailed explanation of how scope keys work across platforms - Added examples for Slack, Linear, GitHub, and API interactions - Explained why scope keys matter for context inheritance - Included best practices and troubleshooting guide - Updated docs navigation to include new architecture section
- Renamed from 'scope-keys' to 'context-inheritance' - Removed technical terms like 'scope key' throughout - Focused on when users should expect context vs fresh starts - Added clear examples of good vs bad interaction patterns - Emphasized practical scenarios and troubleshooting
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. 🚀 New features to boost your workflow:
|
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 detailed documentation explaining how Codegen's scope keys work and why they're important for context inheritance.
What's Added
📚 New Documentation Page:
docs/architecture/scope-keys.mdx🗂️ Updated Navigation: Added new "Architecture" section to docs navigation
Key Concepts Covered
slack-{thread_timestamp}- Groups messages in same threadlinear-{issue_id}- Groups work on same ticketgithub-pr-{pr_number}-{repo_id}- Groups work on same PRWhy This Matters
This documentation addresses the common user confusion about when Codegen creates new PRs vs updating existing ones. Users will now understand:
The examples clearly show the difference between good scope usage (updating existing PRs) and bad scope usage (creating unnecessary new PRs), which directly addresses the issue mentioned in the Slack thread.
💻 View my work • About Codegen