-
Notifications
You must be signed in to change notification settings - Fork 3k
docs: Rules doc improvements #5969
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
docs: Rules doc improvements #5969
Conversation
Your cubic subscription is currently inactive. Please reactivate your subscription to receive AI reviews and use cubic. |
✅ Deploy Preview for continuedev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
All contributors have signed the CLA ✍️ ✅ |
I have read the CLA Document and I hereby sign the CLA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice improvements to the rules docs!
I've made some initial fixes per your review @RomneyDa and @Patrick-Erichsen. I also updated the side nav to flow to ensure theres is a flow of discovery in the file. ![]() I will think through the other comments tonight, but plan on attacking the new markdown syntax and frontmatter features in my next PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, left some nitpicks but not blocking
Note that screenshots in PR description are out of date
updated |
Description
Updating the rules documentation in preparation for improving user on boarding experiences.
fixes: #5968
Checklist
Screenshots
[ For visual changes, include screenshots. Screen recordings are particularly helpful, and appreciated! ]
/agent/how-to-customize
Agent customization includes rules mention and links
/agent/how-to-customize
/blocks/rules
More context in
/blocks/rules
/customize/deep-dives/rules
info block for when rules don't work in
/customize/deep-dives/rules
Added schema as a required option.
Tests
[ What tests were added or updated to ensure the changes work as expected? ]
n/a