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

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

Open
iamazeem opened this issue Aug 7, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@iamazeem
Copy link
Contributor

iamazeem commented Aug 7, 2020

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!

@iamazeem iamazeem changed the title Suggestion: Markdown Linting Suggestion: Markdown Linting with Spelling and Grammar Reporting (Possible automated CI pipeline) Aug 8, 2020
@kenhys kenhys added the enhancement New feature or request label Mar 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants