-
-
Notifications
You must be signed in to change notification settings - Fork 693
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
Documentation revamp #1595
Comments
it sounds like it could be a good idea but id be interested to see a poc or suggested solution we did slip up slightly when releasing the new major and not updating docs, probably because they're decoupled think we also need to review the docs as they are now to at least correct what the major release changed |
I can fiddle with this some more and maybe put on a draft PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I really like the documentation and I want to really try to avoid rewriting it's system but I think we should colocate it with the code in this repo as opposed to keeping it in a different repo. I also think we should generate most of the API documentation from the JSDocs. This way we don't change the code without updating the docs as well.
Here's a loose list of what I think we should do:
jsdoc
eslint plugin to validate that the jsdoc comments are in the correct format.jsdoc
issues.What do you think?
@chaijs/core
The text was updated successfully, but these errors were encountered: