docs: Add documentation for automatic rule file detection #1141
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}
- Document how set_active_codebase automatically discovers agent rule files - Add supported file patterns: .cursorrules, .clinerules, .windsurfrules, *.mdc - Explain 3000 character limit and truncation behavior - Provide examples of rule file structures - Clarify relationship between manual and automatic rules
jayhack
approved these changes
Jun 17, 2025
jayhack
deleted the
codegen-bot/document-automatic-rule-file-detection-1750180327
branch
|
🎉 This PR is included in version 0.56.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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 automatic rule file detection feature that was previously undocumented.
What's Added
New Documentation Section: "Automatic Rule File Detection"
set_active_codebaseautomatically discovers agent rule files.cursorrules(Cursor AI editor rules).clinerules(Cline AI assistant rules).windsurfrules(Windsurf AI editor rules)**/*.mdc(Markdown files with .mdc extension).cursor/rules/**/*.mdc(Markdown files in .cursor/rules/ directory)Technical Details Covered
Examples and Best Practices
Why This Matters
This feature was already implemented and working in production but completely undocumented, leading to potential confusion for users who might not understand why certain behaviors were occurring when they had rule files in their repositories.
The documentation now provides clear guidance on:
Files Changed
docs/settings/repo-rules.mdx- Enhanced with new automatic detection sectionThe existing
docs.jsonnavigation structure already includes this page, so no changes were needed there.💻 View my work • About Codegen