Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Added Vale linter for spelling and APA title case to the docs #131

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Added Vale linter for spelling and APA title case to the docs #131

wants to merge 12 commits into from

Conversation

codeallthethingz
Copy link
Contributor

@codeallthethingz codeallthethingz commented Jan 12, 2025 •
edited
Loading

This PR adds the vale documentation linter to the docs setup.
It enforces spelling and the APA title case for headings. It ignores python snake_case words.

@codeallthethingz codeallthethingz marked this pull request as draft January 12, 2025 15:57
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 12, 2025 •
edited
Loading

📚 Documentation Preview

✅ A preview of the documentation changes in this PR is available for maintainers at:
https://thousandbrainsproject.readme.io/v0.0-add-vale-documenation-linter

Last updated: 2025-01-12 21:10 UTC

@codeallthethingz codeallthethingz changed the title Added spelling and AMA linter to the docs and readme.md Added Vale linter for spelling and AMA title case to the docs Jan 12, 2025
@codeallthethingz codeallthethingz changed the title Added Vale linter for spelling and AMA title case to the docs Added Vale linter for spelling and APA title case to the docs Jan 12, 2025
@codeallthethingz codeallthethingz marked this pull request as ready for review January 12, 2025 21:47
@codeallthethingz codeallthethingz added documentation Improvements or additions to documentation triaged This issue or pull request was triaged labels Jan 12, 2025
@tristanls
Copy link
Contributor

question: How do I use this?

@codeallthethingz
Copy link
Contributor Author

question: How do I use this?

you run vale . from the root directory. Install it here: https://vale.sh/docs/install

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vkakerbeck vkakerbeck Awaiting requested review from vkakerbeck

At least 1 approving review is required to merge this pull request.

Assignees

@vkakerbeck vkakerbeck

Labels
documentation Improvements or additions to documentation triaged This issue or pull request was triaged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@codeallthethingz @tristanls @vkakerbeck