Skip to content

Make some updates to documentation content #18

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.

Sign up for GitHub

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
Oct 6, 2021
Merged

Make some updates to documentation content #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72d8b40
Update lists of supported project types in docs
per1234 Oct 5, 2021
0a9f5df
Update Library Manager FAQ link
per1234 Oct 5, 2021
fa516cd
Update links to GitHub docs for access tokens
per1234 Oct 5, 2021
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/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ See the [official Github documentation][pat-docs] to learn more about Personal A
1. After the release, rebase the release branch for that major version (e.g., `v1` branch for the v1.x.x tags) on the
tag. If no branch exists for the release's major version, create one.

[pat-docs]: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token
[pat-docs]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ projects:
- Libraries
- Sketches
- Boards platforms
- Boards Manager package indexes

## Table of contents

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

### `library-manager`

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

#### Supported values

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

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

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

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

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

## Usage

Expand Down