This is toward #114 . SuperLinter uses markdownlint for linting Markdown. When running the latest version on DGP, I found many violations. Instead of manually requiring conformance to specific style, I replace markdownlint with prettier which will auto-format Markdown files for us.
I've also disabled the natural language validator since there is no corresponding pre-commit hook for it. I don't think this validator is critical. What's more important is that we enforce clear meaning in prose in code review.
Lastly, I've built the docs locally and glanced over them (rather quickly). Everything seems to be okay still, including the PDF generated by rinoh.
tk-woven
commented
1 year ago
Description
This is toward #114 . SuperLinter uses
markdownlintfor linting Markdown. When running the latest version on DGP, I found many violations. Instead of manually requiring conformance to specific style, I replacemarkdownlintwithprettierwhich will auto-format Markdown files for us.I've also disabled the natural language validator since there is no corresponding pre-commit hook for it. I don't think this validator is critical. What's more important is that we enforce clear meaning in prose in code review.
Lastly, I've built the docs locally and glanced over them (rather quickly). Everything seems to be okay still, including the PDF generated by
rinoh.This change is