[skip changelog] Mention interfaces in documentation introduction #1545
+2
−2
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
Unlike the IDE and Web Editor, Arduino CLI is intended to be used directly only by advanced users. However, all types of users are likely to visit the repository and documentation website. Some of these readers will not be familiar with the meaning of the acronym "CLI". The previous documentation introduces Arduino CLI as: > an all-in-one solution that provides [...] to use any Arduino compatible board and platform Which sounds like something any Arduino user would be interested in. Those readers might therefore get the impression this is some sort of GUI application like the IDE and be frustrated after spending time to install and run the program, only to find that it doesn't apparently do anything when they run the executable (because they did it from a file browser or shortcut). It is a bit difficult to describe Arduino CLI's interface in a short introduction because, despite the "CLI" in the name, command line is only one of the interfaces provided by Arduino CLI (the others being the gRPC and Go API). I added the term "machine" to cover the others.
per1234
added
type: enhancement
umbynos
approved these changes
Nov 11, 2021
91volt
approved these changes
Nov 11, 2021
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)Documentation enhancement
Unlike the IDE and Web Editor, Arduino CLI is intended to be used directly only by advanced users. However, all types of
users are likely to visit the repository and documentation website. Some of these readers will not be familiar with the
meaning of the acronym "CLI".
The previous documentation introduces Arduino CLI as:
Which sounds like something every Arduino user would be interested in.
Those readers might therefore get the impression this is some sort of GUI application like the IDE and be frustrated and confused after spending time to install and run the program, only to find that it doesn't apparently do anything when they run the executable (because they did it from a file browser or shortcut).
The introduction in the repository readme and documentation website home page mentions that Arduino CLI's capabilities are provided via command line and machine interfaces.
It is a bit difficult to describe Arduino CLI's interface in a short introduction because, despite the "CLI" in the name,
command line is only one of the interfaces provided by Arduino CLI (the others being the gRPC and Go API). I added the
term "machine" to cover the others.
titled accordingly?
No breaking change.