Skip to content

Suggestion: Markdown Linting with Spelling and Grammar Reporting (Possible automated CI pipeline) #232

Open
@iamazeem

Description

@iamazeem

It is suggested to use markdown-lint extension of VSCode or some other tool(s) to automate the linting of the markdown files. The linting rules may also be configured for the exceptions in .markdownlint.json file and this may be added to this project to enforce the recommended Markdown format setting.

This integration may somehow be automated to create a CI pipeline for the submitted PRs.

The redis-doc is worth to look at. It uses Aspell for spelling mistakes.

Other relevant tools and/or solutions may also be suggested to automate the CI which would definitely help all the future work adhere to the recommended practices resulting in to-the-point reviews i.e. documentation and not the style, spelling, and grammar issues.

Regards!

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions