Skip to content

docs: automated updates for breaking_change#661

Open
jessiemongeon1 wants to merge 1 commit into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260605-055743
Open

docs: automated updates for breaking_change#661
jessiemongeon1 wants to merge 1 commit into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260605-055743

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Collaborator

Summary

Automated documentation updates triggered by recent release notes.

Changes

Triggered by MystenLabs/hashi#659: [Guardian] Carve KP provisioner-init into hashi-guardian-init crate

  • 🔴 design/docs/guardian.mdx

Review details

design/docs/guardian.mdx

The documentation page at guardian.md is currently a stub with minimal content — it describes the guardian concept at a high level but contains no operational instructions, CLI commands, or configuration details whatsoever.

This page needs updating to reflect the new standalone hashi-guardian-init binary and its usage.

What is missing

The page has no section covering how to actually run or initialize the guardian/provisioner. Given that this is the primary documentation page for the Guardian, it should document:

  1. How to run the guardian provisioner initialization: The command is now cargo run -p hashi-guardian-init -- provisioner --config <path>, using the new standalone hashi-guardian-init crate. There is no mention of this anywhere on the page.

  2. Configuration: The sample config file location and the corrected field names (relay_endpoint, hashi_btc_master_pubkey_hex) should be documented or referenced.

Suggested update

After the existing paragraph about 2-of-2 multisig, add a new section such as:


## Guardian Initialization

The guardian provisioner is initialized using the standalone hashi-guardian-init binary:

cargo run -p hashi-guardian-init -- provisioner --config <path-to-config>

The configuration file should include the following fields (among others):

  • relay_endpoint — the endpoint of the relay service
  • hashi_btc_master_pubkey_hex — the hex-encoded master public key for Hashi BTC

Refer to the sample configuration file in the hashi-guardian-init crate for a complete example.


Additionally, the placeholder line "Additional details about the guardian integration are added before Testnet." should be removed or replaced with the actual operational content now that the tooling exists.


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: The `provisioner-init` subcommand has been removed from `hashi-monitor` CLI and moved to a new standalone binary in the `hashi-guardian-init` crate. Users who previously ran `cargo run -p hashi-monitor -- provisioner-init --config ...` must now run `cargo run -p hashi-guardian-init -- provisioner --config ...`. The sample config file has also been relocated and field names corrected (relay_endpoint, hashi_btc_master_pubkey_hex).
@jessiemongeon1 jessiemongeon1 requested a review from bmwill as a code owner June 5, 2026 05:57
@jessiemongeon1

Copy link
Copy Markdown
Collaborator Author

Style Guide Audit

All 1 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