Skip to content

Commit eccb8c7

Browse files
authored
Merge pull request #18 from per1234/update-docs
Make some updates to documentation content
2 parents 86c20b6 + fa516cd commit eccb8c7

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ See the [official Github documentation][pat-docs] to learn more about Personal A
2828
1. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the
2929
tag. If no branch exists for the release's major version, create one.
3030

31-
[pat-docs]: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token
31+
[pat-docs]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ projects:
1111
- Libraries
1212
- Sketches
1313
- Boards platforms
14+
- Boards Manager package indexes
1415

1516
## Table of contents
1617

@@ -60,7 +61,7 @@ Configure how strict the tool is about which checks are considered errors vs war
6061

6162
### `library-manager`
6263

63-
Configure the checks for libraries in the [Arduino Library Manager](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) index.
64+
Configure the checks for libraries in the [Arduino Library Manager](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme) index.
6465

6566
#### Supported values
6667

@@ -78,6 +79,8 @@ Configures which types of projects to check, along with their subprojects.
7879

7980
- `sketch`
8081
- `library`
82+
- `platform` - [boards platform](https://arduino.github.io/arduino-cli/latest/platform-specification/)
83+
- `package-index` - Boards Manager [package index](https://arduino.github.io/arduino-cli/latest/package_index_json-specification/)
8184
- `all` - Run checks on any type of project that is detected
8285

8386
**Default**: `all`
@@ -102,7 +105,7 @@ Set to `true` to show more information in the log about the checks being run.
102105

103106
GitHub access token used to get information from the GitHub API.
104107

105-
**Default**: [`GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow)
108+
**Default**: [`GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
106109

107110
## Usage
108111

0 commit comments

Comments
 (0)