Add documentation style checker #2696
bitwiseman
started this conversation in
Ideas
Replies: 2 comments
-
Yeah, we could extend the Maybe we could start simple by putting a list with phrases in CONTRIBUTING.md? Do you have any suggestions? |
Beta Was this translation helpful? Give feedback.
0 replies
-
Also, it would be important to add a consistent structure to each doc. Such as:
|
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
As this project grows, having clear and consistent documentation will become more important. Docs are already generated from comments.
For example:
Beta Was this translation helpful? Give feedback.
All reactions