[skip changelog] Add note that docs also apply to other Arduino development software #1500
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
…opment software People might get the impression that, since the documentation is in the Arduino CLI repo, it only applies to Arduino CLI. However, since Arduino CLI is used in some form in most of Arduino's development tools, much of the information is universal.
per1234
added
type: enhancement
rsora
approved these changes
Oct 8, 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)Docs update
Due to being implemented in the Arduino CLI code base, some very important developer-targeted technical documentation is hosted in this repository and published on its website:
https://arduino.github.io/arduino-cli/latest/
Since the most obvious use of Arduino CLI is as a standalone tool, this might give the impression that the documentation is only applicable to Arduino CLI. However, since Arduino CLI is used in some form in most of Arduino's development tools, much of the information is universal.
The documentation home page mentions Arduino CLI's role in the other official Arduino development software and explains that the documentation content is not exclusively applicable to the Arduino CLI tool.
titled accordingly?
Not breaking.
There was a previous attempt at this last year: #819