[docs-infra] Fail CI on Vale error

[oliviertassinari]

Now that we start to report errors, I think that we can fail the CI with https://github.com/errata-ai/vale-action?tab=readme-ov-file#fail_on_error-default-false. I have seen enough regressions:

• error but got missed: https://github.com/mui/mui-x/pull/11795/files#diff-6e87a04aee68e9817c58836585170b176f12da25d3536faf95b0773ad4f9b5f0
• no errors: https://github.com/mui/material-ui/pull/40882/files#diff-f0dd1380f4376e5437f33da395c6473a63456cc2771a6ba61051a68b4e330034

I think GitLab is a good example to follow https://docs.gitlab.com/ee/development/documentation/testing/vale.html#result-types

[mui-bot]

Netlify deploy preview

https://deploy-preview-40944--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 902d760

[alexfauquette]

This conflicts with #40403

The issue is that the action that display comment in the PR fails if it has more than 50 comments to do. Usually it's not an issue, but as soon as you move files, you can easily reach it

[oliviertassinari]

This conflicts with #40403. The issue is that the action that display comment in the PR fails if it has more than 50 comments to do. Usually it's not an issue, but as soon as you move files, you can easily reach it

@alexfauquette Arf you are right, in that PR the problem is:

I added a comment in the GitHub Action to link the related GitHub issue errata-ai/vale-action#89. We effectively can't use the GitHub Action to report the status of the CI, only to leave annotations. I have tried to use the other reporter https://github.com/reviewdog/reviewdog?tab=readme-ov-file#reporter-github-pullrequest-review-comment--reportergithub-pr-review but the UX of this is a huge mess (why @mui-bot is involved here).

The solution is to use CircleCI to lint the files. I did this. I also went through the codebase (meaning MUI X, Base UI, Toolpad, Material UI) to fix all the errors. We should be good now 😌.

Benchmark:

• https://github.com/backstage/backstage/commits/5d69520238d6013213b5f358837eab598c787335/scripts/check-docs-quality.js

Extra notes:

• storing the .vale.ini in .github feels clearly wrong, why is Vale's docs encouraging this, it's not about GitHub. A folder for the Vale makes a lot more sense, e.g. https://github.com/meilisearch/documentation/blob/main/.vale.ini#L1 (strange its private here though).