Skip to content

[skip changelog] Update broken or outdated links #1833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 1 addition & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,15 +366,12 @@ 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/
[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
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/command-line-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/integration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/library-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sketch-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)