[skip changelog] Improve wording of docs introduction #1200
Conversation
This file contains hidden or 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
The introductory sentence of the documentation homepage is the first thing the user may see when discovering Arduino CLI. For this reason, it's important for it to quickly and clearly convey what Arduino CLI is. Toward that goal, the following changes are made: - Use more understandable terms - Rearrange features list in the order of typical usage (install dependencies, compile, upload)
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)docs update
The introductory sentence of the documentation homepage is the first thing the user may see when discovering Arduino
CLI. For this reason, it's important for it to quickly and clearly convey what Arduino CLI is. It's possible the current wording could be improved to do a better job of this.
The wording of the sentence is improved via the following changes:
titled accordingly?
No
I have changed the term "discovery" to "board detection". I feel that the meaning of "discovery" in this context is not widely known. The only uses of "discovery" in the documentation refer to library discovery, which is not the meaning of "discovery" in this sentence.
Credit for the suggested changes goes to @ubidefeo