Repository navigation
Add automated docs review CI (#431) - #598
Open
kutluhaneth46 wants to merge 1 commit into
Open
kutluhaneth46 wants to merge 1 commit into
kutluhaneth46 wants to merge 1 commit into
Conversation
Introduce a docs checker (issue flashbots#431) that validates crate git tags against Cargo.toml versions, CLI subcommands in bash examples, and TOML fences. Update library-usage.md to the current <crate>-v<version> tag format and crate versions.
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
1 participant
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.
Summary
scripts/check-docs.pyand aDocsGitHub Actions workflow that validates docs on every PR (addresses automated docs review #431).crates/*/Cargo.tomlversions and the<crate>-v<version>tag format.docs/library-usage.mdtag format (_v→-v) and crate versions.Test plan
python3 scripts/check-docs.pypasses locally