-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add automated linter; make PRs pass "mkdocs serve --strict" #69
Comments
@felker who should this be assigned to? |
I should say who is the TensorFlow SME? Taylor? |
I will fix TensorFlow stylization, but will table the automated linter discussion until there is more interest. |
felker
changed the title
Add automated linter?
Add automated linter; make PRs pass "mkdocs serve --strict"
Mar 3, 2023
with the broken links warnings described in #162 |
partially addressed by #246 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As mentioned in #64, we should consider adding a basic, automated linting step (perhaps in a pre-commit hook) to minimize commit noise and promote uniformity of style:
Some tools here: https://earthly.dev/blog/markdown-lint/, https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
Would be simple to add Python-based linters to the
venv
already required to runmkdocs
, then install a pre-commit hook with one line.The text was updated successfully, but these errors were encountered: