docs(contracts): add docs.rs metadata and workflow verification#224
Merged
Conversation
Contributor
|
Heads-up: CI was green a moment ago but this PR is no longer marked MERGEABLE, so I didn't auto-merge it. Could you rebase against |
Contributor
|
Quick follow-up: my earlier \xe2\x80\x98rebase\xe2\x80\x99 note was a false alarm \xe2\x80\x94 transient issue on my side. \xe2\x9c\x85 Merged now. docs.rs metadata is much appreciated \xe2\x9c\x93 \xe2\x80\x94 makes the contracts much more discoverable. |
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.
Closes #162 This PR resolves the issue of missing published API documentation metadata and verification for all Soroban smart contracts in
contracts/.Changes Included
[package.metadata.docs.rs]and added package metadata (description,repository,license) across all contract packages:contracts/batch-wallet/Cargo.tomlcontracts/gist-registry/Cargo.tomlcontracts/governance/Cargo.tomlcontracts/multisig/Cargo.tomlrepositoryandlicensefields incontracts/Cargo.toml([workspace.package])..github/workflows/contracts-docs.ymlwhich executescargo doc --locked --no-deps --workspacewithRUSTDOCFLAGS="-D warnings"to fail CI on documentation errors or broken links.Verification
$env:RUSTDOCFLAGS="-D warnings"; cargo doc --locked --no-deps --workspace. Documentation for all 4 contracts built cleanly with zero warnings/broken links.