Improve frame-omni-bencher docs #11674
Open
Kanasjnr wants to merge 7 commits intoparitytech:masterfrom
Open
Conversation
Contributor
Author
|
/cmd prdoc --audience node_dev --bump patch |
Contributor
Author
|
/cmd label T1-FRAME I1-refactor R0-no-crate-publish-required |
…e_dev --bump patch'
Contributor
Author
|
@iulianbarbu the pr is ready for review |
4fd8d77 to
9621aa6
Compare
cce7b14 to
f513e26
Compare
Contributor
|
Review required! Latest push from author must always be reviewed |
1 similar comment
Contributor
|
Review required! Latest push from author must always be reviewed |
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.
Description
This PR standardizes the
frame-omni-bencherdocumentation and build pipeline, aligning it with Polkadot-SDK standards (similar tostaging-chain-spec-builder). It automatesREADME.mdgeneration usingdocify, ensuring that all usage examples are backed by verified integration tests.Integration
Downstream projects using
frame-omni-benchercan now utilize thegenerate-readmefeature to keep their documentation in sync with code changes viacargo build -p frame-omni-bencher --features generate-readme.The
substrate-test-runtimenow includes ano-metadata-hash-checkfeature, which can be opted into by tools that do not yet support the latestCheckMetadataHashandWeightReclaimsigned extensions.Closes #6392
Review Notes
Key implementation details:
frame-omni-bencher:docify::compile_markdown!macro gated by a newgenerate-readmefeature.tests/benchmark_works.rsto be resilient to missing WASM binaries; functional execution is now conditionally skipped if a real WASM binary isn't available, while still allowingdocifyto capture usage examples.substrate-test-runtime:no-metadata-hash-checkfeature to feature-gate the recently addedCheckMetadataHashandWeightReclaimextensions in theTxExtensiontuple. This was necessary to resolveCodec errormismatches with the benchmarking CLI duringapply_extrinsic.frame-benchmarking-cli:Example of the new documentation standard in
lib.rs: