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.

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

integrate cspell #237

Closed
wasaga opened this issue Dec 28, 2022 · 4 comments · Fixed by #240
Closed

integrate cspell #237

wasaga opened this issue Dec 28, 2022 · 4 comments · Fixed by #240
Assignees

Comments

@wasaga
Copy link
Contributor

wasaga commented Dec 28, 2022

There are some spelling errors in the docs.
We should add cspell or other spell checker to the build.

i.e. see how Facebook's repo does that https://github.com/facebook/docusaurus/search?q=cspell

@calebdoxsey
Copy link
Contributor

so many false positives. the word list will be very large.

@calebdoxsey
Copy link
Contributor

it doesn't understand things like:

    Authorization: Basic cm9vdDpodW50ZXI0Mg==

I'm not sure how to provide an override without it showing up in the docs themselves, which we don't want.

@calebdoxsey
Copy link
Contributor

turns out we can add directives to the front matter in md files

@desimone
Copy link
Collaborator

Should we add a precommit check to keep things pristine?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants