Skip to content

Support Markdown syntax Check #404

Open
@samzong

Description

@samzong

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/featureCategorizes issue or PR as related to a new feature.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions