docs: automated updates for cli_change#556
Open
jessiemongeon1 wants to merge 2 commits into
Open
Conversation
Automated update based on: CLI change: added --rpc-url flag for package-digest command to resolve package environments for custom networks. Also changed DKG message signing to include domain separator and committee_id in signed payload, which is a protocol-level change.
Automated update based on: CLI change: added --rpc-url flag for package-digest command to resolve package environments for custom networks. Also changed DKG message signing to include domain separator and committee_id in signed payload, which is a protocol-level change.
Contributor
Author
Style Guide AuditAll 2 file(s) pass the style guide audit. |
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.
Summary
Automated documentation updates triggered by recent release notes.
Changes
Triggered by MystenLabs/seal#555: [cli] add ds for signing, add logs, fix custom network path
docs/content/SealCLI.mdxdocs/content/Design.mdxReview details
docs/content/SealCLI.mdxThe documentation page needs updating to reflect the addition of the
--rpc-urlflag. While the page doesn't explicitly document apackage-digestcommand, it does document CLI commands and their flags, and more importantly, the--rpc-urlflag may also be relevant to other commands that interact with the network (likeencryptandfetch-keysin section 7).Let me look more carefully at the change: the PR adds
--rpc-urlspecifically for thepackage-digestcommand. Thepackage-digestcommand is not currently documented on this page at all.However, looking at section 7, the
encryptandfetch-keyscommands use-n testnet(the--networkflag) to specify the network. The--rpc-urlflag was added specifically for thepackage-digestcommand to support custom networks. Thepackage-digestcommand itself is not documented on this page.What needs updating:
A new section should be added (e.g., after section 7 or as a subsection) documenting the
package-digestcommand, including its--rpc-urlflag for custom network support.The
package-digestcommand is a CLI subcommand that computes the digest of a package, and the new--rpc-urlflag allows users to specify a custom RPC URL to resolve the package for networks beyond the built-in ones (like testnet/mainnet).Suggested addition:
The
--rpc-urlflag is optional and allows you to point to a custom Sui full node RPC endpoint, which is useful when working with custom or local networks.This is a missing command/feature that should be documented alongside the other CLI commands on this page.
docs/content/Design.mdxBased on the PR description, this involves two changes:
--rpc-urlflag for thepackage-digestcommandSince the documentation page at
https://seal-docs.wal.app/Design.mdfailed to fetch (503 error), I cannot review its current content to determine whether it already covers these changes or needs updating.However, based on what I can assess:
--rpc-urlflag change is unlikely to be relevant to a design document.I cannot make a definitive recommendation without being able to read the page content. If the page becomes accessible, it should be reviewed specifically for:
This PR was automatically generated by the Docs Impact Monitor. Please review the changes carefully before merging.
Each file edit was generated by Claude based on the release notes and a review of the existing documentation content.