Skip to content

Commit 513f5a1

Browse files
authoredAug 11, 2022
[skip changelog] Update broken or outdated links (#1833)
* [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. * [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 * [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.
1 parent 312cfdb commit 513f5a1

8 files changed

+18
-21
lines changed
 

‎.github/ISSUE_TEMPLATE/bug-report.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml
22
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
33

44
name: Bug report

‎.github/ISSUE_TEMPLATE/feature-request.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.md
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/feature-request.yml
22
# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
33

44
name: Feature request

‎docs/CONTRIBUTING.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -366,15 +366,12 @@ If your PR doesn't need to be included in the changelog, please start the commit
366366
**[skip changelog]**
367367

368368
[0]: https://cla-assistant.io/arduino/arduino-cli
369-
[1]: https://golang.org/doc/install
369+
[1]: https://go.dev/doc/install
370370
[2]: https://taskfile.dev/#/installation
371371
[3]: https://www.python.org/downloads/
372-
[4]: https://docs.python.org/3/tutorial/venv.html
373-
[5]: https://github.com/ofek/hatch
374372
[6]: https://github.com/protocolbuffers/protobuf/releases
375373
[7]: https://pages.github.com/
376374
[9]: https://www.mkdocs.org/
377-
[10]: https://github.com/jimporter/mike
378375
[11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml
379376
[12]:
380377
https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md

‎docs/FAQ.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If your question wasn't answered, feel free to ask on [Arduino CLI's forum board
3131

3232
[arduino cli board list]: commands/arduino-cli_board_list.md
3333
[0]: platform-specification.md
34-
[1]: https://forum.arduino.cc/index.php?board=145.0
34+
[1]: https://forum.arduino.cc/c/software/arduino-cli/89
3535
[screen]: https://www.gnu.org/software/screen/manual/screen.html
3636
[putty]: https://www.chiark.greenend.org.uk/~sgtatham/putty/
3737
[monitor command]: commands/arduino-cli_monitor.md

‎docs/command-line-completion.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ Remember to open a new shell to test the functionality.
3838

3939
Use `arduino-cli completion fish > arduino-cli.fish` to generate the completion file. At this point you can place the
4040
file in `~/.config/fish/completions` as stated in the
41-
[official documentation](http://fishshell.com/docs/current/index.html#where-to-put-completions). Remember to create the
42-
directory if it's not already there `mkdir -p ~/.config/fish/completions/` and then place the completion file in there
43-
with `mv arduino-cli.fish ~/.config/fish/completions/`
41+
[official documentation](https://fishshell.com/docs/current/completions.html#where-to-put-completions). Remember to
42+
create the directory if it's not already there `mkdir -p ~/.config/fish/completions/` and then place the completion file
43+
in there with `mv arduino-cli.fish ~/.config/fish/completions/`
4444

4545
Remember to open a new shell to test the functionality.
4646

‎docs/integration-options.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ contains [example code showing how to implement a gRPC client][grpc client examp
8787
designed the low level API, have a look at the [commands package] and don’t hesitate to leave feedback on the [issue
8888
tracker] if you’ve got a use case that doesn’t fit one of the three pillars.
8989

90-
[golang]: https://golang.org/
90+
[golang]: https://go.dev/
9191
[arduino pro ide]: https://www.arduino.cc/pro/arduino-pro-ide
92-
[arduino cloud]: https://create.arduino.cc
92+
[arduino cloud]: https://cloud.arduino.cc/home
9393
[continuous integration]: https://en.wikipedia.org/wiki/Continuous_integration
9494
[continuous deployment]: https://en.wikipedia.org/wiki/Continuous_deployment
9595
[configuration documentation]: configuration.md

‎docs/library-specification.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and
1414
as well as [`arduino-cli lib`](commands/arduino-cli_lib.md).
1515

1616
More information about how Library Manager works is available
17-
[here](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
17+
[here](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme).
1818

1919
Arduino development software supports multiple microcontroller architectures (e.g. AVR, SAM, etc), meaning that
2020
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.
2323

2424
## See also
2525

26-
- [Arduino library style guide](http://docs.arduino.cc/learn/contributions/arduino-library-style-guide)
26+
- [Arduino library style guide](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide)
2727
- [Library dependency resolution process documentation](sketch-build-process.md#dependency-resolution)
2828

2929
## 1.5 library format (rev. 2.2)
@@ -44,9 +44,9 @@ otherwise below, **all fields are required**. The available fields are:
4444
- **name** - the name of the library. Library names must contain only basic letters (A-Z or a-z) and numbers (0-9),
4545
spaces ( ), underscores (\_), dots (.) and dashes (-). They must start with a letter or number. They must contain at
4646
least one letter. Note that libraries with a `name` value starting with `Arduino` will no longer be allowed
47-
[addition to the Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) as these names
48-
are now reserved for official Arduino libraries.
49-
- **version** - version of the library. Version should be [semver](http://semver.org/) compliant. 1.2.0 is correct; 1.2
47+
[addition to the Library Manager index](https://github.com/arduino/library-registry/blob/main/README.md#adding-a-library-to-library-manager)
48+
as these names are now reserved for official Arduino libraries.
49+
- **version** - version of the library. Version should be [semver](https://semver.org/) compliant. 1.2.0 is correct; 1.2
5050
is accepted; r5, 003, 1.1c are invalid
5151
- **author** - name/nickname of the authors and their email addresses (not mandatory) separated by comma (,)
5252
- **maintainer** - name and email of the maintainer
@@ -276,7 +276,7 @@ Editor.
276276
More information:
277277

278278
- [Arduino sketch specification](sketch-specification.md)
279-
- [Style guide for Arduino examples](https://www.arduino.cc/en/Reference/StyleGuide)
279+
- [Style guide for Arduino examples](https://docs.arduino.cc/learn/contributions/arduino-writing-style-guide)
280280

281281
#### Extra documentation
282282

@@ -360,8 +360,8 @@ Normally the Arduino IDE treats the contents of the library folder as read-only.
360360
accidentally modifying example sketches. During the library development process you may want to edit example sketches in
361361
place using the Arduino IDE. With Arduino IDE 1.6.6 and newer, the read-only behavior can be disabled by adding a file
362362
named .development to the root of the library folder. A [library.properties](#libraryproperties-file-format) file must
363-
also be present. The [Library Manager indexer](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) will not
364-
pick up releases that contain a .development file so be sure not to push this file to your remote repository.
363+
also be present. The [Library Manager indexer](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme) will
364+
not pick up releases that contain a .development file so be sure not to push this file to your remote repository.
365365

366366
### A complete example
367367

‎docs/sketch-specification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,4 +168,4 @@ This feature was added in Arduino IDE 1.6.9.
168168
## See also
169169

170170
- [Sketch build process documentation](sketch-build-process.md)
171-
- [Style guide for example sketches](https://www.arduino.cc/en/Reference/StyleGuide)
171+
- [Style guide for example sketches](https://docs.arduino.cc/learn/contributions/arduino-writing-style-guide)

0 commit comments

Comments
 (0)
Please sign in to comment.