[docs] Lint markdown in the CI #30395
Merged
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
oliviertassinari
added
docs
oliviertassinari
force-pushed
the
markdown-lint
branch
from
4f9388c to
9e0b92b
Compare
Member
Author
|
I will wait for feedback on mui/mui-x#3504 from X before moving forward. |
Member
|
Approved on X |
github-actions
bot
added
the
PR: out-of-date
oliviertassinari
force-pushed
the
markdown-lint
branch
from
9e0b92b to
2cd3186
Compare
github-actions
bot
removed
the
PR: out-of-date
oliviertassinari
changed the title
oliviertassinari
force-pushed
the
markdown-lint
branch
from
2cd3186 to
18f989f
Compare
wladimirguerra
pushed a commit
to wladimirguerra/material-ui
that referenced
this pull request
Feb 2, 2022
| @@ -0,0 +1,26 @@ | |||
| { | |||
Member
Author
There was a problem hiding this comment.
In the future, we could look into how to make it a JavaScript file so that the same configuration can be shared with other repositories rather than copied & pasted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
I have discovered this browsing https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/#session-1-4-minutes and working on https://www.notion.so/mui-org/Technical-writting-7e55b517ac2e489a9ddb6d0f6dd765de. It seems brilliant.
One example of problems it could solve for us: #30114 (comment). It's similar to twbs/bootstrap#29919. In the future, we could explore https://www.notion.so/mui-org/Improve-docs-linting-418115486b6a4aecbef59173902fad21.