From e7c9dafebc877c6adcb21b73013e013754e31b5f Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Aug 2022 20:54:44 -0700 Subject: [PATCH 1/3] [skip changelog] Remove unused link reference definitions in docs Parts of the documentation use reference links, where the inline markup uses a label, which matches to a link reference definition elsewhere in the documentation. The major disadvantage of this approach is that unused link reference definitions are often left behind after the referencing text is removed, cluttering up the documentation and increasing the maintenance burden. That was the case here. The unused link reference definitions are hereby removed. --- docs/CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 829eb21cbcb..a76d271e0b2 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -369,12 +369,9 @@ If your PR doesn't need to be included in the changelog, please start the commit [1]: https://golang.org/doc/install [2]: https://taskfile.dev/#/installation [3]: https://www.python.org/downloads/ -[4]: https://docs.python.org/3/tutorial/venv.html -[5]: https://github.com/ofek/hatch [6]: https://github.com/protocolbuffers/protobuf/releases [7]: https://pages.github.com/ [9]: https://www.mkdocs.org/ -[10]: https://github.com/jimporter/mike [11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml [12]: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md From 521b4fb6fbb202c99f417a1d1f662e537869dcbd Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Aug 2022 21:04:53 -0700 Subject: [PATCH 2/3] [skip changelog] Fix broken links in documentation Some of the documentation links no longer reached their intended target. These were not caught by the Markdown link check for one of two reasons: - Redirects to a useless generic page instead of the moved specific target page - Links in non-Markdown files --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- docs/command-line-completion.md | 6 +++--- docs/library-specification.md | 2 +- docs/sketch-specification.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index c65b6591e53..519e95caac9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,4 +1,4 @@ -# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md +# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml # See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms name: Bug report diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 5f0fc1e28e8..5008773fa12 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,4 +1,4 @@ -# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md +# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/feature-request.yml # See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms name: Feature request diff --git a/docs/command-line-completion.md b/docs/command-line-completion.md index 50c4aab7ac0..af11a5d4ccd 100644 --- a/docs/command-line-completion.md +++ b/docs/command-line-completion.md @@ -38,9 +38,9 @@ Remember to open a new shell to test the functionality. Use `arduino-cli completion fish > arduino-cli.fish` to generate the completion file. At this point you can place the file in `~/.config/fish/completions` as stated in the -[official documentation](http://fishshell.com/docs/current/index.html#where-to-put-completions). Remember to create the -directory if it's not already there `mkdir -p ~/.config/fish/completions/` and then place the completion file in there -with `mv arduino-cli.fish ~/.config/fish/completions/` +[official documentation](https://fishshell.com/docs/current/completions.html#where-to-put-completions). Remember to +create the directory if it's not already there `mkdir -p ~/.config/fish/completions/` and then place the completion file +in there with `mv arduino-cli.fish ~/.config/fish/completions/` Remember to open a new shell to test the functionality. diff --git a/docs/library-specification.md b/docs/library-specification.md index d3d233c52b3..701ae96523d 100644 --- a/docs/library-specification.md +++ b/docs/library-specification.md @@ -276,7 +276,7 @@ Editor. More information: - [Arduino sketch specification](sketch-specification.md) -- [Style guide for Arduino examples](https://www.arduino.cc/en/Reference/StyleGuide) +- [Style guide for Arduino examples](https://docs.arduino.cc/learn/contributions/arduino-writing-style-guide) #### Extra documentation diff --git a/docs/sketch-specification.md b/docs/sketch-specification.md index 4cc4876df19..b65a3163cfc 100644 --- a/docs/sketch-specification.md +++ b/docs/sketch-specification.md @@ -168,4 +168,4 @@ This feature was added in Arduino IDE 1.6.9. ## See also - [Sketch build process documentation](sketch-build-process.md) -- [Style guide for example sketches](https://www.arduino.cc/en/Reference/StyleGuide) +- [Style guide for example sketches](https://docs.arduino.cc/learn/contributions/arduino-writing-style-guide) From fb260570b7c4c440c6b0200f1b0ed8a3817ccc2a Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Aug 2022 21:09:52 -0700 Subject: [PATCH 3/3] [skip changelog] Update documentation links that depend on redirects Some of the links in the documentation used URLs that were redirecting to the new location of the target page. Even though these links still took the reader to the intended place eventually, it is safest to not rely on them continuing to work for the long term, so is best to update to point directly to the target. --- docs/CONTRIBUTING.md | 2 +- docs/FAQ.md | 2 +- docs/integration-options.md | 4 ++-- docs/library-specification.md | 14 +++++++------- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a76d271e0b2..56048aafb32 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -366,7 +366,7 @@ If your PR doesn't need to be included in the changelog, please start the commit **[skip changelog]** [0]: https://cla-assistant.io/arduino/arduino-cli -[1]: https://golang.org/doc/install +[1]: https://go.dev/doc/install [2]: https://taskfile.dev/#/installation [3]: https://www.python.org/downloads/ [6]: https://github.com/protocolbuffers/protobuf/releases diff --git a/docs/FAQ.md b/docs/FAQ.md index 4dd052f809a..661209c64d3 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -31,7 +31,7 @@ If your question wasn't answered, feel free to ask on [Arduino CLI's forum board [arduino cli board list]: commands/arduino-cli_board_list.md [0]: platform-specification.md -[1]: https://forum.arduino.cc/index.php?board=145.0 +[1]: https://forum.arduino.cc/c/software/arduino-cli/89 [screen]: https://www.gnu.org/software/screen/manual/screen.html [putty]: https://www.chiark.greenend.org.uk/~sgtatham/putty/ [monitor command]: commands/arduino-cli_monitor.md diff --git a/docs/integration-options.md b/docs/integration-options.md index 6583a272c61..a0a978828a0 100644 --- a/docs/integration-options.md +++ b/docs/integration-options.md @@ -87,9 +87,9 @@ contains [example code showing how to implement a gRPC client][grpc client examp designed the low level API, have a look at the [commands package] and don’t hesitate to leave feedback on the [issue tracker] if you’ve got a use case that doesn’t fit one of the three pillars. -[golang]: https://golang.org/ +[golang]: https://go.dev/ [arduino pro ide]: https://www.arduino.cc/pro/arduino-pro-ide -[arduino cloud]: https://create.arduino.cc +[arduino cloud]: https://cloud.arduino.cc/home [continuous integration]: https://en.wikipedia.org/wiki/Continuous_integration [continuous deployment]: https://en.wikipedia.org/wiki/Continuous_deployment [configuration documentation]: configuration.md diff --git a/docs/library-specification.md b/docs/library-specification.md index 701ae96523d..1d0373b2e9c 100644 --- a/docs/library-specification.md +++ b/docs/library-specification.md @@ -14,7 +14,7 @@ and as well as [`arduino-cli lib`](commands/arduino-cli_lib.md). More information about how Library Manager works is available -[here](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ). +[here](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme). Arduino development software supports multiple microcontroller architectures (e.g. AVR, SAM, etc), meaning that libraries may need to work on multiple architectures. The new 1.5 library format doesn’t contain special support for @@ -23,7 +23,7 @@ code to specific architectures. ## See also -- [Arduino library style guide](http://docs.arduino.cc/learn/contributions/arduino-library-style-guide) +- [Arduino library style guide](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide) - [Library dependency resolution process documentation](sketch-build-process.md#dependency-resolution) ## 1.5 library format (rev. 2.2) @@ -44,9 +44,9 @@ otherwise below, **all fields are required**. The available fields are: - **name** - the name of the library. Library names must contain only basic letters (A-Z or a-z) and numbers (0-9), spaces ( ), underscores (\_), dots (.) and dashes (-). They must start with a letter or number. They must contain at least one letter. Note that libraries with a `name` value starting with `Arduino` will no longer be allowed - [addition to the Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) as these names - are now reserved for official Arduino libraries. -- **version** - version of the library. Version should be [semver](http://semver.org/) compliant. 1.2.0 is correct; 1.2 + [addition to the Library Manager index](https://github.com/arduino/library-registry/blob/main/README.md#adding-a-library-to-library-manager) + as these names are now reserved for official Arduino libraries. +- **version** - version of the library. Version should be [semver](https://semver.org/) compliant. 1.2.0 is correct; 1.2 is accepted; r5, 003, 1.1c are invalid - **author** - name/nickname of the authors and their email addresses (not mandatory) separated by comma (,) - **maintainer** - name and email of the maintainer @@ -360,8 +360,8 @@ Normally the Arduino IDE treats the contents of the library folder as read-only. accidentally modifying example sketches. During the library development process you may want to edit example sketches in place using the Arduino IDE. With Arduino IDE 1.6.6 and newer, the read-only behavior can be disabled by adding a file named .development to the root of the library folder. A [library.properties](#libraryproperties-file-format) file must -also be present. The [Library Manager indexer](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) will not -pick up releases that contain a .development file so be sure not to push this file to your remote repository. +also be present. The [Library Manager indexer](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme) will +not pick up releases that contain a .development file so be sure not to push this file to your remote repository. ### A complete example