Add mdx linting to match docs repo
Open
Nobody has claimed this yet.
bug
P1
- Dominant language
- JavaScript
- Stars
- 24
- Forks
- 41
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 12
Description
The docs repo has been updated to include stricter linting on markdown files. This means docs won't be updated if the docs parser starts getting picky.
@taylordowns2000 likes the stictness of the docs parser because it catches genuine errors. So the only solution I can see to stop docs builds failing silently is to introduce matching linting here in this repo.
So we need:
- To copy/duplicate the linting settings from the docs repo into here
- Add a new script like
lint:docsto this repo - Run the new script in CI. The build must fail if docs errors are encountered
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.