Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Use Placeholder for Validator Identity Key in Documentation #3573

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

joaolago1113
Copy link
Contributor

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.

Copy link
Member

@hdevalence hdevalence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, this is a helpful change!

@hdevalence hdevalence merged commit 44a6a7c into penumbra-zone:main Jan 4, 2024
7 checks passed
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.

2 participants