-
Notifications
You must be signed in to change notification settings - Fork 31
Open
Labels
docsImprovements or additions to the documentation.Improvements or additions to the documentation.scope: all componentsWidespread work has an impact on almost all components.Widespread work has an impact on almost all components.scope: docs-infraInvolves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).status: waiting for maintainerThese issues haven't been looked at yet by a maintainer.These issues haven't been looked at yet by a maintainer.
Description
Summary
We have this rule when it comes to writing great error messages https://www.notion.so/mui-org/DevEx-Technical-writing-style-guide-7e55b517ac2e489a9ddb6d0f6dd765de#85219822c3194b6f8a49ee08ea82b90a.
Up until now, we couldn't automate our projets to follow it because it required human to determine either the message followed the rule or not. However, we now have LLMs that can do this, at scale, and at a fraction of the resource cost.
So it looks like we should:
- Ask AI agent to go through all the codebase to clean things up.
- If it worked, have some sort of a CI lining rule that can reports mistakes. Maybe AI skills, if token cheap enough or an AST matcher and forward.
Action plan:
- Add rule in Material UI [code-infra] Add initial agent instructions material-ui#47655
- Run rule in Material UI
- Add rule in MUI X
- Run rule in MUI X
- Add rule in Base UI
- Run rule in Base UI
Examples
No response
Motivation
Similar to #222, improve the DX when things go wrong. Make recovering, for humans, AI easy.
Search keywords: -
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docsImprovements or additions to the documentation.Improvements or additions to the documentation.scope: all componentsWidespread work has an impact on almost all components.Widespread work has an impact on almost all components.scope: docs-infraInvolves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).status: waiting for maintainerThese issues haven't been looked at yet by a maintainer.These issues haven't been looked at yet by a maintainer.