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

[docs] Correctly configure Vale #244

Merged
merged 1 commit into from
Sep 19, 2024
Merged

[docs] Correctly configure Vale #244

merged 1 commit into from
Sep 19, 2024

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Sep 18, 2024

Vale wasn't configured correctly during this repository creation. Running:

vale sync && git ls-files | grep -h ".md$" | xargs vale --filter='.Level=="error"'

shouldn't crash. I fixed the problems at the same time. I have noticed having a quick look at mui/material-ui#43395.

cc @alelthomas I don't know if you get exposed to Vale in the past https://vale.sh/. We are trying to encode as many writing style rule we have as possible so engineers have good guiderails when writing docs.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Sep 18, 2024
@oliviertassinari oliviertassinari merged commit 40da08b into master Sep 19, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants