Skip to content

docs: automated updates for cli_change#556

Open
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260520-212149
Open

docs: automated updates for cli_change#556
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260520-212149

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Contributor

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.mdx
  • 🔴 docs/content/Design.mdx

Review details

docs/content/SealCLI.mdx

The documentation page needs updating to reflect the addition of the --rpc-url flag. While the page doesn't explicitly document a package-digest command, it does document CLI commands and their flags, and more importantly, the --rpc-url flag may also be relevant to other commands that interact with the network (like encrypt and fetch-keys in section 7).

Let me look more carefully at the change: the PR adds --rpc-url specifically for the package-digest command. The package-digest command is not currently documented on this page at all.

However, looking at section 7, the encrypt and fetch-keys commands use -n testnet (the --network flag) to specify the network. The --rpc-url flag was added specifically for the package-digest command to support custom networks. The package-digest command itself is not documented on this page.

What needs updating:

  1. A new section should be added (e.g., after section 7 or as a subsection) documenting the package-digest command, including its --rpc-url flag for custom network support.

    The package-digest command is a CLI subcommand that computes the digest of a package, and the new --rpc-url flag allows users to specify a custom RPC URL to resolve the package for networks beyond the built-in ones (like testnet/mainnet).

    Suggested addition:

    ## 8. Compute a package digest
    
    Compute the digest of a Seal policy package. By default, the CLI resolves the package using known networks, but you can specify a custom RPC URL for other networks.
    
    ```shell
    cargo run --bin seal-cli package-digest \
        --package-id <PACKAGE_ID> \
        --rpc-url <CUSTOM_RPC_URL>
    

    The --rpc-url flag 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.mdx

Based on the PR description, this involves two changes:

  1. CLI change: Added --rpc-url flag for the package-digest command
  2. Protocol change: DKG message signing now includes domain separator and committee_id in signed payload

Since the documentation page at https://seal-docs.wal.app/Design.md failed 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:

  • The Design.md page likely covers the protocol design. The DKG message signing change (adding domain separator and committee_id to the signed payload) is a protocol-level change that could be relevant to this page if it describes the DKG protocol details or message formats.
  • The CLI --rpc-url flag 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:

  1. Any section describing the DKG (Distributed Key Generation) protocol, particularly message signing or payload structure — it may need to be updated to reflect that the signed payload now includes a domain separator and committee_id.
  2. Any description of security properties of DKG messages — the addition of domain separation and committee binding is a meaningful security improvement that the design doc should reflect if it discusses DKG security.

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.

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.
@jessiemongeon1

Copy link
Copy Markdown
Contributor Author

Style Guide Audit

All 2 file(s) pass the style guide audit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant