Skip to content

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

Merged
merged 15 commits into from
Jun 9, 2025

Conversation

bdougie
Copy link
Collaborator

@bdougie bdougie commented Jun 3, 2025

Description

Updating the rules documentation in preparation for improving user on boarding experiences.

fixes: #5968

Checklist

  • I've read the contributing guide
  • The relevant docs, if any, have been updated or created
  • The relevant tests, if any, have been updated or created

Screenshots

[ For visual changes, include screenshots. Screen recordings are particularly helpful, and appreciated! ]

/agent/how-to-customize

Screenshot 2025-06-03 at 2 41 33 PM

Agent customization includes rules mention and links /agent/how-to-customize

/blocks/rules

Screenshot 2025-06-03 at 2 41 44 PM

More context in /blocks/rules

Screenshot 2025-06-03 at 2 45 07 PM

/customize/deep-dives/rules

info block for when rules don't work in /customize/deep-dives/rules

Screenshot 2025-06-04 at 1 38 31 PM

Added schema as a required option.

Tests

[ What tests were added or updated to ensure the changes work as expected? ]

n/a

Copy link

cubic-dev-ai bot commented Jun 3, 2025

Your cubic subscription is currently inactive. Please reactivate your subscription to receive AI reviews and use cubic.

Copy link

netlify bot commented Jun 3, 2025

Deploy Preview for continuedev ready!

Name Link
🔨 Latest commit e87a3a5
🔍 Latest deploy log https://app.netlify.com/projects/continuedev/deploys/6840ae15ba2a880008f3b634
😎 Deploy Preview https://deploy-preview-5969--continuedev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

github-actions bot commented Jun 3, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@bdougie
Copy link
Collaborator Author

bdougie commented Jun 3, 2025

I have read the CLA Document and I hereby sign the CLA

@bdougie bdougie marked this pull request as ready for review June 3, 2025 22:04
@bdougie bdougie requested a review from a team as a code owner June 3, 2025 22:04
@bdougie bdougie requested review from RomneyDa and removed request for a team June 3, 2025 22:04
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 3, 2025
RomneyDa
RomneyDa previously approved these changes Jun 3, 2025
Copy link
Collaborator

@RomneyDa RomneyDa left a 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!

@github-project-automation github-project-automation bot moved this from Todo to In Progress in Issues and PRs Jun 3, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jun 3, 2025
@RomneyDa RomneyDa dismissed their stale review June 3, 2025 22:10

Missed some comments

@dosubot dosubot bot removed the lgtm This PR has been approved by a maintainer label Jun 3, 2025
@dosubot dosubot bot removed the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 3, 2025
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 3, 2025
@bdougie
Copy link
Collaborator Author

bdougie commented Jun 3, 2025

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.

Screenshot 2025-06-03 at 4 13 02 PM

I will think through the other comments tonight, but plan on attacking the new markdown syntax and frontmatter features in my next PR.

@bdougie
Copy link
Collaborator Author

bdougie commented Jun 4, 2025

I've addressed more of the comments and continue the improvement. Now rules deep dive includes a quick start, more examples, and section titles.

Screenshot 2025-06-03 at 9 52 21 PM

The Quick is a pirates-rule.yaml. A simple example support the feature discovery. Open to other ideas here or in the example section.

Screenshot 2025-06-03 at 9 48 29 PM

@bdougie bdougie requested a review from RomneyDa June 4, 2025 17:48
RomneyDa
RomneyDa previously approved these changes Jun 4, 2025
Copy link
Collaborator

@RomneyDa RomneyDa left a 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

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jun 4, 2025
@bdougie
Copy link
Collaborator Author

bdougie commented Jun 4, 2025

Note that screenshots in PR description are out of date

updated

@bdougie bdougie merged commit 10d7423 into continuedev:main Jun 9, 2025
34 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Issues and PRs Jun 9, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jun 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Rules documentation is out of date
4 participants