[DOC]: Investigate using vale.sh as part of our CI #545
Assignees
Labels
doc
Improvements or additions to documentation
Comments
morpheus-bot-test
bot
moved this from In Progress
to Review - Ready for Review
in Morpheus Boards
rapids-bot bot
pushed a commit
that referenced
this issue
Aug 1, 2024
* Add [vale](https://github.com/errata-ai/vale) as a documentation linter to CI * Add custom vocabulary (`ci/vale/styles/config/vocabularies/morpheus/accept.txt`). * Add sphinx's linkcheck to the documentation builds * Fix spelling & grammar errors found in existing documentation Closes #545 ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md). - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - David Gardner (https://github.com/dagardner-nv) Approvers: - Michael Demoret (https://github.com/mdemoret-nv) - https://github.com/hsin-c URL: #1821
github-project-automation
bot
moved this from Review - Ready for Review
to Done
in Morpheus Boards
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
How would you describe the priority of this documentation request
Low (would be nice)
Describe the future/missing documentation
Vale.sh appears to be similar to clang-format but for documentation, and is able to parse markdown & rst files, and is able to run run spell/style/bias checks on the content.
https://vale.sh/
https://github.com/errata-ai/vale
Where have you looked?
No response
Code of Conduct
The text was updated successfully, but these errors were encountered: