docs(iroh-cli): point to the configuration refernce from each iroh subcommand #2571
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
matheus23
approved these changes
Aug 1, 2024
b5
approved these changes
Aug 1, 2024
dignifiedquire
approved these changes
Aug 1, 2024
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.
Description
#2537 mentions someone not finding the configuration options after running
iroh start --help.iroh --helpalready mentions both https://iroh.computer/docs in the second line and https://iroh.computer/docs/reference/config in the config flag (this onebeing fairly recent addition to the help text). I'd say the only thing missing here is to be able to see the docs from the subcommands, which is what this pr does.
Breaking Changes
n/a
Notes & open questions
n/a
Change checklist
Documentation updates following the style guide, if relevant.Tests if relevant.All breaking changes documented.