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

Integrate a documentation linter to improve readability #57

Closed
busykoala opened this issue Feb 8, 2023 · 0 comments · Fixed by #58
Closed

Integrate a documentation linter to improve readability #57

busykoala opened this issue Feb 8, 2023 · 0 comments · Fixed by #58
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature

Comments

@busykoala
Copy link
Owner

Is your feature request related to a problem? Please describe.
The documentation is crucial to the users of this package. It is important to continuously work on the documentation and make it as readable as possible.

Describe the solution you'd like
One way to improve upon the documentation is to follow some guidelines.
Vale provides some great templates to integrate with widely used guidelines and check them for documentation files.

Describe alternatives you've considered
There are many other solutions on the market while Vale addresses and combines some of the most important topics (general guidelines, naive linting, readability, sexism, etc.).

@busykoala busykoala added documentation Improvements or additions to documentation enhancement New feature or request feature labels Feb 8, 2023
@busykoala busykoala self-assigned this Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant