implement cargo_rdme readme automation for vello_hybrid
#1362
+42
−15
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
…d-docs-automation
waywardmonkeys
previously requested changes
Jan 15, 2026
sparse_strips/vello_hybrid/README.md
Outdated
| cargo rdme --workspace-project=vello_hybrid --heading-base-level=0 | ||
| Full documentation at https://github.com/orium/cargo-rdme --> | ||
|
|
||
| <<<<<<< HEAD |
Collaborator
There was a problem hiding this comment.
Still has conflict markers that need to be resolved...
Contributor
Author
There was a problem hiding this comment.
yep, can't believe i missed that. I'll fix that
Collaborator
|
You'll also want to update |
Contributor
Author
it's on the pipeline now |
DJMcNab
approved these changes
Jan 16, 2026
Member
DJMcNab
left a comment
DJMcNab
left a comment
There was a problem hiding this comment.
Thanks. I've pushed a few changes myself:
- I've removed the accidental reformatting of the rest of the ci.yml file.
- I've removed the double header (pre-existing issue)
- I've reduced the heading levels to match the usual expected Rust style (pre-existing issue)
- I've removed some unused links (pre-existing issue)
In general, I recommend giving any PR you open a once-over in the GitHub "Files changed" tab, to see if anything looks amiss.
DJMcNab
dismissed
waywardmonkeys’s stale review
The conflict markers are now gone
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves #1361
Using the established pattern in the workspace, this PR adds cargo-rdme markers for vello_hybrid. It ensures that the README.md is automatically synchronised with the module-level documentation in src/lib.rs
Just added cargo-rdme markers to vello_hybrid/README.md and then synchronized the files using cargo rdme --workspace-project=vello_hybrid.
You can verify by running cargo rdme --workspace-project=vello_hybrid --check. This will confirm the files are in sync without making changes.
Something to note is that the README did change. The descriptions and sections, features changed to key features and an architecture section was added.
Let me know if this is okay, thank you