docs: automated updates for breaking_change#661
Open
jessiemongeon1 wants to merge 1 commit into
Open
Conversation
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).
Collaborator
Author
Style Guide AuditAll 1 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/hashi#659: [Guardian] Carve KP provisioner-init into hashi-guardian-init crate
design/docs/guardian.mdxReview details
design/docs/guardian.mdxThe documentation page at
guardian.mdis 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-initbinary 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:
How to run the guardian provisioner initialization: The command is now
cargo run -p hashi-guardian-init -- provisioner --config <path>, using the new standalonehashi-guardian-initcrate. There is no mention of this anywhere on the page.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-initbinary:The configuration file should include the following fields (among others):
relay_endpoint— the endpoint of the relay servicehashi_btc_master_pubkey_hex— the hex-encoded master public key for Hashi BTCRefer to the sample configuration file in the
hashi-guardian-initcrate 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.