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] Fix some Vale errors #190

Merged
merged 1 commit into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ commands:
browsers:
type: boolean
default: false
description: 'Set to true if you intend to any browser (e.g. with playwright).'
description: 'Set to true if you intend to any browser (for example with playwright).'

steps:
- run:
Expand Down
16 changes: 0 additions & 16 deletions .github/styles/Blog/BrandName.yml

This file was deleted.

13 changes: 0 additions & 13 deletions .github/styles/Blog/ComposedWords.yml

This file was deleted.

19 changes: 0 additions & 19 deletions .github/styles/Blog/NamingConventions.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/styles/Blog/NoCompanyName.yml

This file was deleted.

11 changes: 0 additions & 11 deletions .github/styles/Blog/Typos.yml

This file was deleted.

Empty file removed .github/styles/Vocab/accept.txt
Empty file.
Empty file removed .github/styles/Vocab/reject.txt
Empty file.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,6 @@ package-lock.json
size-snapshot.json
# vale downloaded config
.github/styles/Google
.github/styles/write-good
.github/styles/MUI
.github/styles/.vale-config
.nx/cache
45 changes: 19 additions & 26 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -1,34 +1,27 @@
# Config vale. More information at https://docs.errata.ai/vale/config
# Vale config. More information at https://vale.sh/docs/topics/config/
StylesPath = .github/styles
MinAlertLevel = suggestion
MinAlertLevel = warning

Packages = Google
# To update mui-vale package:
# 1. Go to the docs folder in the material-ui repo
# 2. Update/create YAML files
# 3. Run `pnpm docs:zipRules` to generate the zip files
# 4. You can test locally by replacing the url with the file path of the generated zip
Packages = Google, https://github.com/mui/material-ui/raw/HEAD/docs/mui-vale.zip

[*.md]
# Ignore code injection which start with {{...
# Ignore code injections that start with {{...
BlockIgnores = {{.*

# Custom syle
# BasedOnStyles = Blog
BasedOnStyles = MUI

Blog.ComposedWords = YES
Blog.NamingConventions = YES
Blog.Typos = YES
Blog.BrandName = YES
Blog.NoCompanyName = YES
# Google errors:
Google.GenderBias = YES # No Gender bias
# Google warings:
Google.FirstPerson = YES # Avoid first-person
Google.We = YES # Avoid first-person plural
Google.Will = YES # Avoid future tense
Google.OxfordComma = YES # Prefer Oxford comma

# Google:
Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
Google.GenderBias = YES # Avoid gendered profession
Google.OxfordComma = YES
Google.Quotes = YES # Commas and periods go inside quotation marks.
Google.Spelling = YES # In general, use American spelling (word ending with 'nised' or 'logue')
Google.We = YES # Try to avoid using first-person plural
Google.Latin = YES # Try to avoid latin expressions e.g. and i.e.

# Those rules are not repected a lot
# Google.Passive = YES # In general, use active voice instead of passive voice.
Google.Will = YES # Avoid using will

# False positives with "1st" nearly no use in our doc
# Google.Units = YES # Put a nonbreaking space between the number and the unit
[CHANGELOG*.md]
MUI.CorrectReferenceAllCases = NO
Loading
Loading