[skip changelog] Use relative links for documentation pages #799
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
Now that the documentation system uses versioning, absolute links can cause the reader to experience an unexpected change in the documentation version being viewed.
rsora
approved these changes
Jul 8, 2020
ubidefeo
reviewed
Jul 9, 2020
| @@ -5,7 +5,7 @@ This is the specification for the 3rd party library format to be used with Ardui | |||
| * rev.2.1 will be implemented starting from version Arduino IDE 1.6.10 | |||
| * rev.2.2 will be implemented starting from version Arduino IDE 1.8.10 | |||
|
|
|||
| This new library format is intended to be used in tandem with **Library Manager**, available since Arduino IDE 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface in the [Arduino IDE](https://www.arduino.cc/en/guide/libraries#toc3)/Pro IDE and [Arduino Web Editor](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a#toc-libraries-and-the-arduino-web-editor-11) as well as [`arduino-cli lib`](https://arduino.github.io/arduino-cli/commands/arduino-cli_lib/). | |||
| This new library format is intended to be used in tandem with **Library Manager**, available since Arduino IDE 1.6.2. The Library Manager allows users to automatically download and install libraries needed in their projects, with an easy to use graphic interface in the [Arduino IDE](https://www.arduino.cc/en/guide/libraries#toc3)/Pro IDE and [Arduino Web Editor](https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a#toc-libraries-and-the-arduino-web-editor-11) as well as [`arduino-cli lib`](../commands/arduino-cli_lib). | |||
| @@ -55,7 +55,7 @@ The Arduino IDE's **File > Save As...** only copies the code files in the sketch | |||
|
|
|||
| Arduino CLI and Arduino Web Editor use a file named sketch.json, located in the sketch root folder, to store sketch metadata. | |||
|
|
|||
| The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](https://arduino.github.io/arduino-cli/commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` or `--port` flags to the [`arduino-cli compile`](https://arduino.github.io/arduino-cli/commands/arduino-cli_compile/) or [`arduino-cli upload`](https://arduino.github.io/arduino-cli/commands/arduino-cli_upload/) commands when compiling or uploading the sketch. | |||
| The `cpu` key contains the board configuration information. This can be set via [`arduino-cli board attach`](../commands/arduino-cli_board_attach/) or by selecting a board in the Arduino Web Editor while the sketch is open. With this configuration set, it is not necessary to specify the `--fqbn` or `--port` flags to the [`arduino-cli compile`](../commands/arduino-cli_compile/) or [`arduino-cli upload`](../commands/arduino-cli_upload/) commands when compiling or uploading the sketch. | |||
There was a problem hiding this comment.
this generates confusion.
why would selecting the cpu option remove requirement for the port option?
There was a problem hiding this comment.
cpu is not really an great name for the key. Something like "board" would have been better.
If I run this command:
arduino-cli board attach serial:///dev/ttyACM0 HelloWorld
It writes a sketch.json sketch metadata file to the HelloWorld sketch that looks something like:
{
"cpu": {
"fqbn": "arduino:avr:mega",
"name": "Arduino Mega or Mega 2560",
"port": "serial:///dev/ttyACM0"
}
}So now if I don't specify a --port option when running an arduino-cli command with the HelloWorld sketch, the cpu.port value from sketch.json is automatically used.
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
Documentation fix.
The documentation contains absolute links to internal pages. Now that the documentation system uses versioning, these links can cause the reader to experience an unexpected change in the version of the documentation they are browsing.
All links to internal documentation pages are relative.
No.