OpenFn / OpenFn/adaptors

Add mdx linting to match docs repo

Open
#1,241 5 comments 0 reactions 1 assignee View on GitHub

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:docs to 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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.