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

[docs-infra] Add vale for style-guide lint on docs #3178

Merged
merged 17 commits into from
Feb 22, 2024
Merged

[docs-infra] Add vale for style-guide lint on docs #3178

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
aa1be84
docs-infra: Add vale for style-guide lint on docs
bharatkashyap Feb 8, 2024
861692d
Merge branch 'master' into docs-vale
bharatkashyap Feb 8, 2024
f6892ef
fix: Jan review
bharatkashyap Feb 9, 2024
a198773
Merge branch 'master' into docs-vale
bharatkashyap Feb 20, 2024
82a571b
fix: Prettier
bharatkashyap Feb 20, 2024
7d5eccb
Merge branch 'docs-vale' of github.com:bharatkashyap/mui-toolpad into…
bharatkashyap Feb 20, 2024
9699729
feat: Use config sharing
bharatkashyap Feb 21, 2024
781f707
Update .gitignore
bharatkashyap Feb 22, 2024
6f46f5d
Update .gitignore
bharatkashyap Feb 22, 2024
19e35f4
Update .vale.ini
bharatkashyap Feb 22, 2024
0cc8166
Update .vale.ini
bharatkashyap Feb 22, 2024
3f39e44
Update .vale.ini
bharatkashyap Feb 22, 2024
f2d94bc
Update .vale.ini
bharatkashyap Feb 22, 2024
0bc0f2d
Update .vale.ini
bharatkashyap Feb 22, 2024
5539e92
Update .vale.ini
bharatkashyap Feb 22, 2024
a187dd4
Update .vale.ini
bharatkashyap Feb 22, 2024
9210c80
Merge branch 'master' into docs-vale
bharatkashyap Feb 22, 2024
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
16 changes: 0 additions & 16 deletions .github/styles/Blog/BrandName.yml
View file
Open in desktop

This file was deleted.

24 changes: 0 additions & 24 deletions .github/styles/Blog/ComponentNaming.yml
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions .github/styles/Blog/ComposedWords.yml
View file
Open in desktop

This file was deleted.

17 changes: 0 additions & 17 deletions .github/styles/Blog/NamingConventions.yml
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions .github/styles/Blog/NoCompanyName.yml
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions .github/styles/Blog/Typos.yml
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,4 @@ test-results
/test/regressions/screenshots/**

# vale downloaded config
.github/styles/*
!.github/styles/Blog
.github/styles/
14 changes: 8 additions & 6 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@
StylesPath = .github/styles
MinAlertLevel = suggestion

# Run `vale sync` to include packages: https://vale.sh/hub/google/
Packages = Google
# To update writing-rules package:
# 1. Go on material-ui repo on the docs folder
# 2. Update/create YAML files
# 3. run `pnpm docs:zipRules` to generate the zip files.
# 4. You can test locally by replacing the url by the file path of the generated zip
Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have no guarantees that master is the active branch:

Suggested change
Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip
Packages = Google, https://github.com/mui/material-ui/raw/HEAD/docs/writing-rules.zip

handled in #3293.


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

# Custom syle
# BasedOnStyles = Blog
BasedOnStyles = writing-rules


Blog.ComposedWords = YES
Blog.NamingConventions = YES
Blog.Typos = YES

# Google:
Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
Expand Down
Loading