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

Support Markdown syntax Check #404

Open
samzong opened this issue Jul 3, 2023 · 3 comments
Open

Support Markdown syntax Check #404

samzong opened this issue Jul 3, 2023 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@samzong
Copy link
Member

samzong commented Jul 3, 2023

following Markdown syntax guidelines will improving the readability and understanding of documents. Just like code, we need follow some rules of markdown files.

What would you like to be added:

Referring to https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md, select a suitable checklist that will serve as part of our document writing guidelines.

Why is this needed:

The benefits of following Markdown syntax guidelines include:

  • Improved readability and consistency of documents.
  • Increased compatibility, ensuring proper rendering across different platforms.
  • Support for extended features to enrich document content.
  • Enhanced maintainability and efficiency in updating documents.
@samzong samzong added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 3, 2023
@samzong
Copy link
Member Author

samzong commented Jul 3, 2023

@RainbowMango @Poor12 @windsonsea

Invite you to participate in the design process. I will prepare a document and we can talk about at this week's developer meeting.

@windsonsea
Copy link
Member

We can pick some or part of MD001 - MD047 to apply for a test, provide contributors an opportunity to learning those syntax gradually.

If possible, a guide will be more helpful, which instructs how to add new and update the markdown rules.

@RainbowMango
Copy link
Member

Great!
Are we going to introduce a GitHub Action Job or something?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants