Document rpi-connect 2.1.0's new doctor CLI #3910
Merged
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
Rather than having users run connectivity checks themselves, document the new rpi-connect doctor CLI command and what it tests. While the doctor will output various things users can try, keep the details of our servers and ports in case someone wants to check their network ahead of time.
lurch
reviewed
Nov 7, 2024
|
Is it worth mentioning something along the lines of "More information is available by typing |
nathan-contino
approved these changes
Nov 7, 2024
There was a problem hiding this comment.
Looks good, made some minor wording and order changes to better fit our docs style. In particular I split up the doctor command example into separate input/output blocks, moved the doctor network requirements into a call-to-action after the command example, and trimmed some words from the network requirements. Specifically, I changed some 'and' and 'or' usages, added ports and URLs to each bullet point, and made the TURN servers explicit (instead of making people figure out the TURN servers from a list in a separate bullet point).
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.
Rather than having users run connectivity checks themselves, document the new rpi-connect doctor CLI command and what it tests.
While the doctor will output various things users can try, keep the details of our servers and ports in case someone wants to check their network ahead of time.