docs icon indicating copy to clipboard operation
docs copied to clipboard

Feature: Add Documenation Linting to CI/CD

Open nickytonline opened this issue 9 months ago • 17 comments

Type of feature

📦 Chore

Current behavior

Currently there is nothing checking for stuff like an acronym being used before it's defined in documentation.

I came across this while reviewing #177

Suggested solution

It made me think of the docs linting we used at Netlify. I think this could be a great addition to maintaining our docs. More about it here, https://www.netlify.com/blog/a-key-to-high-quality-documentation-docs-linting-in-ci-cd/

Additional context

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

Contributing Docs

  • [X] I agree to follow this project's Contribution Docs

nickytonline avatar Sep 27 '23 19:09 nickytonline