[skip changelog] Sync install docs from "template" #1544
Merged
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
This document provides a list of installation options. The user may pick any one option that is most convenient for them. However, a reader might get the impression that it is a list of instructions that must be followed from top to bottom. An introduction makes the situation immediately clear to the reader.
A significant portion of Arduino users use Windows. The first option listed in the installation instructions is for an installation shell script, which can be used on Windows, but might not be convenient for some Windows users. This could be discouraging or frustrating to potential new users, but not necessarily so because the script is an optional convenience and directly downloading and installing the tool is also an option, as documented in the instructions for the second listed option. A little refinement of the wording of the script's `sh` requirement makes the situation clear to those users.
A reference link provides easy access to the relevant information for readers who are not familiar with this concept while not harming readability for everyone else by increasing verbosity.
This document is intended to provide a list of installation options: - brew - script - download - build but the heading levels were misaligned, which resulted in this structure: -brew - script - download - build
per1234
added
type: enhancement
umbynos
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 and fix
A defect fix and multiple improvements have been made to the upstream "template" installation documentation which this project's installation docs are based on:
https://github.com/arduino/tooling-project-assets/blob/main/other/installation-script/installation.md
The defect is present in this repository's installation instructions and the improvements are not.
This repository's installation documentation is at the state of the art.
titled accordingly?
No breaking change.