-
-
Notifications
You must be signed in to change notification settings - Fork 413
[docs-infra] Add vale for style-guide lint on docs #3178
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
Merged
+54
−0
Merged
Changes from 7 commits
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 861692d
Merge branch 'master' into docs-vale
bharatkashyap f6892ef
fix: Jan review
bharatkashyap a198773
Merge branch 'master' into docs-vale
bharatkashyap 82a571b
fix: Prettier
bharatkashyap 7d5eccb
Merge branch 'docs-vale' of github.com:bharatkashyap/mui-toolpad into…
bharatkashyap 9699729
feat: Use config sharing
bharatkashyap 781f707
Update .gitignore
bharatkashyap 6f46f5d
Update .gitignore
bharatkashyap 19e35f4
Update .vale.ini
bharatkashyap 0cc8166
Update .vale.ini
bharatkashyap 3f39e44
Update .vale.ini
bharatkashyap f2d94bc
Update .vale.ini
bharatkashyap 0bc0f2d
Update .vale.ini
bharatkashyap 5539e92
Update .vale.ini
bharatkashyap a187dd4
Update .vale.ini
bharatkashyap 9210c80
Merge branch 'master' into docs-vale
bharatkashyap File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| name: Vale action | ||
|
|
||
| on: [pull_request] | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| vale: | ||
| name: runner / vale | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
| - uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084 # v2.0.1 | ||
| with: | ||
| reporter: github-pr-review | ||
| files: docs/data | ||
| env: | ||
| # Required, set by GitHub actions automatically: | ||
| # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret | ||
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,29 @@ | ||||||
| #Config vale. More information at https://docs.errata.ai/vale/config | ||||||
| StylesPath = .github/styles | ||||||
| MinAlertLevel = suggestion | ||||||
|
|
||||||
| # To update writing-rules package: | ||||||
| # 1. Go on material-ui repo on the docs folder | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| # 2. Update/create YAML files | ||||||
| # 3. run `pnpm docs:zipRules` to generate the zip files. | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| # 4. You can test locally by replacing the url by the file path of the generated zip | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| Packages = Google, https://github.com/mui/material-ui/raw/master/docs/writing-rules.zip | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We have no guarantees that master is the active branch:
Suggested change
handled in #3293. |
||||||
|
|
||||||
| [*.md] | ||||||
| # Ignore code injection which start with {{... | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| BlockIgnores = {{.* | ||||||
|
|
||||||
| # Custom syle | ||||||
| BasedOnStyles = writing-rules | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| # Google: | ||||||
| Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. | ||||||
| Google.GenderBias = YES # Avoid gendered profession | ||||||
| Google.OxfordComma = YES | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| Google.Quotes = YES # Commas and periods go inside quotation marks. | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| Google.Spelling = YES #In general, use American spelling (word ending with 'nised' or 'logue') | ||||||
bharatkashyap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| Google.We = YES # Try to avoid using first-person plural | ||||||
| Google.Latin = YES # Try to avoid latin expressions e.g. and i.e. | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.