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-infra] Add Vale integration for automatic style and grammar linting #32486

Closed
samuelsycamore opened this issue Apr 27, 2022 · 3 comments · Fixed by #39633
Closed

[docs-infra] Add Vale integration for automatic style and grammar linting #32486

samuelsycamore opened this issue Apr 27, 2022 · 3 comments · Fixed by #39633
Assignees
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product

Comments

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Apr 27, 2022

Summary 💡

I've been talking about this with @oliviertassinari for quite awhile now, and it's time to move forward with it!

Vale is a command-line tool that brings code-like linting to prose.

With Vale, we can translate our Style guide into a set of rules that live within the Core and X repos.

Running Vale as a command line tool on a document gives you a list of suggested changes based on our house rules.

That's pretty cool on its own, but it's even cooler when you add the GitHub Action.
Whenever you create or edit an .md file, it will automatically run Vale and leave line-by-line suggestions:

screenshot of Vale GitHub Action prose review

It appears that most of the work is just formatting the style rules. I've started that process today, and I'll open a PR once I have something to show for it. From there, I'll test it out on some docs with the CLI, tweak as needed, then move on to set up the Action.

Motivation 🔦

This will be a huge help when writing new docs and blog posts, especially for the non-native English speakers on the team.

I believe it will also go a long way towards expediting the work that needs to be done to implement the Style guide across the entire docs site, and it will make it much easier for anyone to jump in and contribute to that work.

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused. blog labels Apr 27, 2022
@samuelsycamore samuelsycamore self-assigned this Apr 27, 2022
@vj-codes
Copy link

@samuelsycamore hey I've worked with GitHub action integrations before, can I work on this?

@danilo-leal danilo-leal added scope: docs-infra Specific to the docs-infra product and removed docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused. blog labels Sep 4, 2023
@danilo-leal danilo-leal changed the title [docs] Add Vale integration for automatic style and grammar linting [docs-infra] Add Vale integration for automatic style and grammar linting Sep 4, 2023
@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label Sep 4, 2023
@oliviertassinari
Copy link
Member

MUI X using Vale since mui/mui-x#5429.

@samuelsycamore
Copy link
Contributor Author

If the X team has found it useful, then let's go for it! We should be able to copy their style guide rules over easily enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants