2503 doc autogen #2539
Open
2503 doc autogen #2539
Conversation
This file contains 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
Open
owenwahlgren
added
the
DO NOT MERGE
owenwahlgren
removed
the
DO NOT MERGE
|
What is the output path of the doc? The generated doc will then be referenced in docs at: https://docs.avax.network/tooling/avalanche-cli , right? |
output of the .md file is in root of this project |
cmd/commands.md
Outdated
Comment on lines
152
to
157
| -l, --local operate on a local network | ||
| -m, --mainnet operate on mainnet | ||
| --node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint | ||
| --node-id string node-id of the validator to add | ||
| --output-tx-path string (for Subnets, not L1s) file path of the add validator tx | ||
| --partial-sync set primary network partial sync for new validators (default true) |
There was a problem hiding this comment.
Some of the flags are being generated without a type, causing the description to split (see original line 152)
Suggested change
| -l, --local operate on a local network | |
| -m, --mainnet operate on mainnet | |
| --node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint | |
| --node-id string node-id of the validator to add | |
| --output-tx-path string (for Subnets, not L1s) file path of the add validator tx | |
| --partial-sync set primary network partial sync for new validators (default true) | |
| -l, --local none operate on a local network | |
| -m, --mainnet none operate on mainnet | |
| --node-endpoint string gather node id/bls from publicly available avalanchego apis on the given endpoint | |
| --node-id string node-id of the validator to add | |
| --output-tx-path string (for Subnets, not L1s) file path of the add validator tx | |
| --partial-sync none set primary network partial sync for new validators (default true) |
There was a problem hiding this comment.
Is this due to the script or the CLI command code? This happens consistently throughout the generated commands doc
meaghanfitzgerald
approved these changes
Jan 13, 2025
|
closes #2503 |
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.
Why this should be merged
Autogenerate markdown for CLI cmds that can be remotely fetched
How this works
Github action on PR to main with python script that generates markdown