refactor: Use Placeholder for Validator Identity Key in Documentation #3573
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.
I've been following the instructions for running a full node and setting up a validator. During this process, I noticed that in the section for delegating to a validator, the documentation provides an example command with a specific address. Here is the current command:
pcli tx delegate 1penumbra --to penumbravalid1g2huds8klwypzczfgx67j7zp6ntq2m5fxmctkf7ja96zn49d6s9qz72hu3
While executing these steps quickly, I inadvertently used the example address in the command without realizing it. This might be a common oversight for others who are also setting up their nodes and validators in a similar manner.
To prevent such mistakes, I propose we use a placeholder for the validator's identity key, similar to how it's done in the governance section of the Penumbra guide: https://guide.penumbra.zone/main/pcli/governance.html#getting-proposal-information
The revised command would look like this:
pcli tx delegate 1penumbra --to [YOUR_VALIDATOR_IDENTITY_KEY]
Using
[YOUR_VALIDATOR_IDENTITY_KEY]
in caps lock as a placeholder makes it clear that users need to replace this part with their specific validator's identity key. This format is more user-friendly and minimizes the risk of users accidentally using the example address.Thank you for considering this suggestion.