Check readme stays in sync with source docs - #36
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a CI-enforced README synchronization check that regenerates README.md from crate-level Rust docs and fails when the committed README is stale.
Changes:
- Replaces
cargo readmewith a nightlyrustdocJSON +jqREADME generation path. - Adds a
readmeGitHub Actions job and includes it in the aggregatecompletejob. - Updates
README.mdto match the generated crate documentation output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
README.md |
Regenerated from crate doc comments to match the new source-of-truth format. |
Makefile |
Updates the readme target to generate README content from rustdoc JSON. |
.github/workflows/rust.yml |
Adds the README consistency check to CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mootz12
approved these changes
May 28, 2026
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
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.
What
Add a CI job that regenerates README.md from the crate's doc comments and fails if it differs from what's committed. Uses the same
cargo +nightly rustdoc -Zunstable-options -wjsonplus jq approach already in use in stellar/rs-soroban-sdk, replacing the previous cargo-readme dependency.Why
Mirror the readme-check pattern from stellar/rs-soroban-sdk so this crate catches stale READMEs in CI the same way.