You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Due to the flexibility of Markdown, its writing may not work well in various parsers due to its structure, which is why document projects need to use MarkdownLint reason.
When I tried to check it with markdownlint-cli, there are many places that need to be changed. After ignoring the single line length (MD013) rule, there are still 444 places that need to be considered for modification.
Perhaps some rules are not very important, but it is indeed a delicate work that needs to be checked item by item to ensure the accuracy of the document content.
By creating this Issue, I hope to gradually correct the non-standard Markdown in the Docs warehouse, and link to this Issue when submitting a Pull Request.
From the perspective of an active external contributor, ensuring that each Pull Request is complete, simple, and readable, I think this is a friendly performance of the Maintainer.
Hope that those who intend to participate in this action can keep your changes as "readable" and "maintainable" as possible, instead of changing dozens of documents in one brain.
While this makes these pull requests look "less high quality", it is necessary. This will help you and the Maintainer move the documentation forward faster.
The text was updated successfully, but these errors were encountered:
Description
Due to the flexibility of Markdown, its writing may not work well in various parsers due to its structure, which is why document projects need to use MarkdownLint reason.
When I tried to check it with
markdownlint-cli
, there are many places that need to be changed. After ignoring the single line length (MD013
) rule, there are still 444 places that need to be considered for modification.Perhaps some rules are not very important, but it is indeed a delicate work that needs to be checked item by item to ensure the accuracy of the document content.
By creating this Issue, I hope to gradually correct the non-standard Markdown in the Docs warehouse, and link to this Issue when submitting a Pull Request.
While this makes these pull requests look "less high quality", it is necessary. This will help you and the Maintainer move the documentation forward faster.
The text was updated successfully, but these errors were encountered: