Skip to content

Commit d29272c

Browse files
authored
Merge pull request #1185 from per1234/update-links
Improve and correct links in documentation
2 parents cfe1dc7 + dd55ef3 commit d29272c

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

.github/workflows/manage-prs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
# comment and merge.
1414
# Note that this means the version of the workflow from the PR base ref will be used as opposed to the head ref, as is
1515
# the case with pull_request triggered workflows.
16-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
16+
# See: https://docs.github.com/actions/reference/events-that-trigger-workflows#pull_request_target
1717
pull_request_target:
1818
types:
1919
- opened
@@ -61,7 +61,7 @@ jobs:
6161
head: ${{ steps.head.outputs.head }}
6262

6363
env:
64-
# See: https://docs.github.com/en/rest/reference/pulls#custom-media-types-for-pull-requests
64+
# See: https://docs.github.com/rest/reference/pulls#custom-media-types-for-pull-requests
6565
DIFF_IDENTIFIER: diff
6666
JSON_IDENTIFIER: raw+json
6767

@@ -535,7 +535,7 @@ jobs:
535535
${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged.
536536
537537
Please follow this guide to sync your fork:
538-
https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork
538+
https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork
539539
540540
Once that is done, it will be merged automatically.
541541
@@ -554,7 +554,7 @@ jobs:
554554
${{ env.ERROR_MESSAGE_PREFIX }}Your submission meets all requirements. However, the pull request could not be merged.
555555
556556
Please follow this guide to resolve a merge conflict:
557-
https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github
557+
https://docs.github.com/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github
558558
559559
Once that is done, it will be merged automatically.
560560

FAQ.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ When a library is [added to the library list](README.md#adding-a-library-to-libr
4343

4444
More information:
4545

46-
- https://www.arduino.cc/en/Guide/Libraries#toc3
46+
- https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager
4747
- https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/
4848
- https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-on-various-platforms-4b3e4a
4949

@@ -77,9 +77,9 @@ Follow the instructions [here](README.md#adding-a-library-to-library-manager).
7777
- [ ] For 3rd party libraries, the `name` field in library.properties must not start with `Arduino`.
7878
- [ ] The library repository must not contain any `.exe` files.
7979
- [ ] The library repository must not contain a [`.development` file](https://arduino.github.io/arduino-cli/latest/library-specification/#development-flag-file).
80-
- [ ] The library repository must not contain any [symlinks](https://en.wikipedia.org/wiki/Symbolic_link).
80+
- [ ] The library repository must not contain any [symlinks](https://wikipedia.org/wiki/Symbolic_link).
8181
- [ ] The library repository must not contain any files detected as infected by our antivirus scan.
82-
- [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)) and must have been compliant with all the above requirements at the time of that tag.
82+
- [ ] The library repository must have a [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) (or [release](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)) and must have been compliant with all the above requirements at the time of that tag.
8383
- [ ] The library repository must be hosted on a major Git-hosting website like GitHub, BitBucket or GitLab (other hosting sites may be considered on request).
8484

8585
Arduino has created a command line tool to check libraries for compliance with all the Library Manager requirements:
@@ -102,7 +102,7 @@ Note that libraries will need to be compliant with [all requirements](#update-re
102102

103103
1. Make sure the library is compliant with [all requirements](#update-requirements).
104104
1. Update the `version` in the library's [`library.properties`](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)).
105-
1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)).
105+
1. Tag the library's repository once more and push the new tag (or create a release if the library's Git-hosting site offers a way to do it, for example with [GitHub "releases"](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)).
106106

107107
[Our indexer](#how-is-the-library-manager-index-generated) checks for new releases every hour and will eventually fetch and publish the new release.
108108

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Arduino Library Manager list
22

33
This repository contains the list of libraries in the
4-
[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) index.
4+
[Arduino Library Manager](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager) index.
55

66
## Table of Contents
77

@@ -25,7 +25,7 @@ For more information about Arduino Library Manager and how the index is maintain
2525
## Adding a library to Library Manager
2626

2727
If you would like to make a library available for installation via Library Manager, just submit a
28-
[pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)
28+
[pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests)
2929
that adds the repository URL to [the list](repositories.txt). You are welcome to add multiple libraries at once.
3030

3131
See the instructions below for detailed instructions on how to do this via the GitHub web interface.
@@ -54,7 +54,7 @@ with your pull request or with the library.
5454
#### If the problem is with the pull request:
5555

5656
Edit the file in the
57-
[branch](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)
57+
[branch](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)
5858
you submitted the pull request from in your fork of the `arduino/library-registry` repository, then commit.
5959

6060
Doing this will update the pull request and cause the automated checks to run again.
@@ -65,7 +65,7 @@ Doing this will update the pull request and cause the automated checks to run ag
6565
1. Increment the `version` value in the library's
6666
[library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata).
6767
1. Create a
68-
[release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository)
68+
[release](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
6969
or [tag](https://git-scm.com/docs/git-tag). The Library Manager index always uses tagged versions of the libraries,
7070
so even if the development version of the library is compliant, it can't be accepted until the latest release or tag
7171
is compliant. Alternatively, you can redo the existing release/tag if you prefer.

0 commit comments

Comments
 (0)