[docs-infra] Add vale for style-guide lint on docs #3178
Merged
+54
−0
Conversation
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
bharatkashyap
added
the
scope: docs-infra
Janpot
reviewed
Feb 8, 2024
Janpot
reviewed
Feb 8, 2024
Janpot
reviewed
Feb 8, 2024
Janpot
approved these changes
Feb 8, 2024
Member
Janpot
left a comment
Janpot
left a comment
There was a problem hiding this comment.
Few small comments. How can we share configs between projects?
Collaborator
Author
We could probably define a common, custom GitHub action that runs with our intended configuration? |
Member
|
@bharatkashyap Could this help us? |
Member
We will have to add the client/server side rules. But otherwise I think yes it would be better to copy what will be in mui/mui-x#12132 such that @samuelsycamore can update rules at one place to enforce every repo to use it (or at least be aware of them) |
Janpot
reviewed
Feb 21, 2024
Janpot
reviewed
Feb 21, 2024
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Bharat Kashyap <[email protected]>
| # 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/master/docs/writing-rules.zip |
Member
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
valeto enforce style guide rules #3167