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.

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

merged 3 commits into from
Oct 6, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Oct 5, 2021

A few parts of the documentation content had become outdated since the time they were written. This brings them up to date.

The documentation for the `project-type` input was written at the time of the initial release of the project. At that time Arduino Lint only had full support for sketch and library project types, but the support for boards platforms and package indexes was incomplete. Since that time, full support has been added for boards platforms and package indexes but the action's documentation was not updated accordingly.
The FAQ has been moved to the dedicated repository for the Library Manager registry. The previous page contains a redirect link, but it will be a better experience for the reader of this documentation to be taken directly to the final page.
The action's documentation contains a link to GitHub's documentation about the access token that is provided for use in
GitHub Actions workflows, and another about creating personal access tokens. These pages have been moved since the time
the links were added. Even though the previous page redirects to the new location, it's best not to rely on redirects.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Oct 5, 2021
@per1234 per1234 merged commit eccb8c7 into arduino:main Oct 6, 2021
@per1234 per1234 deleted the update-docs branch October 6, 2021 09:21
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants