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

update avalanche-cli headers #1908

Merged
merged 5 commits into from
Oct 10, 2024
Merged

update avalanche-cli headers #1908

merged 5 commits into from
Oct 10, 2024

Conversation

owenwahlgren
Copy link
Contributor

No description provided.

Copy link

vercel bot commented Oct 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
avalanche-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 6:36pm

Copy link
Collaborator

@meaghanfitzgerald meaghanfitzgerald left a comment

Choose a reason for hiding this comment

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

It isn't clear that all the commands on this page should begin with avalanche i.e.:

 avalanche blockchain create <name>

Additionally, some of these commands have now had their titles altered and import commands shortened, i.e:

### Upgrade VM

This command entered into the cli would be written entirely as avalanche blockchain upgrade vm <blockchainName>

The command should be either included in its entirety in the heading, or commands that have nested headings must be accompanied by text underneath that states the entire command, beginning with avalanche to avoid confusion.

-------------------------------------------

The `blockchain` command suite provides a collection of tools for developing and deploying Avalanche L1s.

To get started, use the `blockchain create` command wizard to walk through the configuration of your very first Avalanche L1. Then, go ahead and deploy it with the `blockchain deploy` command. You can use the rest of the commands to manage your Avalanche L1 configurations and live deployments.

### Avalanche L1 AddValidator
### Blockchain Add Validator
Copy link
Collaborator

Choose a reason for hiding this comment

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

So either:

Suggested change
### Blockchain Add Validator
### Avalanche Blockchain AddValidator

Comment on lines 168 to 170
### Blockchain Create
The `blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or:

Suggested change
### Blockchain Create
The `blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.
### Blockchain Create
The `avalanche blockchain create` command builds a new genesis file to configure your Avalanche L1. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Avalanche L1.

@meaghanfitzgerald meaghanfitzgerald merged commit 78b579b into master Oct 10, 2024
3 checks passed
@meaghanfitzgerald meaghanfitzgerald deleted the cli-commands-update branch October 10, 2024 20:08
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