Add infrastructure to check Markdown files for problems #64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tasks and a GitHub Actions workflow are added for detecting problems in the project's Markdown files. On every push and pull request that affects relevant files, and periodically, the workflow will check the repository's Markdown files for problems: - Use markdownlint to check for common problems and formatting. - Use markdown-link-check to check for broken links. The Arduino tooling Markdown style is defined by the `.markdownlint.yml` file. In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a `.markdownlintignore` file: https://github.com/igorshubovych/markdownlint-cli#ignoring-files markdown-link-check is configured via the `.markdown-link-check.json` file: https://github.com/tcort/markdown-link-check#config-file-format
The project readme contains a table of contents in order to facilitate the navigation of the documentation. It is important that this table of contents is kept in sync with the documentation content. A task is added for automatically generating the ToC from the content of the file. A GitHub Actions workflow is added to check the table of contents. On every push or pull request that affects relevant files, it will check whether the table of contents matches the file structure.
These links result in invalid markup in the automatically generated table of contents. They were not essential in any way and it is probably not a great idea to put links in headings anyway so they are removed.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #64 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are standardized assets maintained at https://github.com/arduino/tooling-project-assets