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

Question: organization of documentation #355

Open
creisle opened this issue Jul 29, 2019 · 0 comments
Open

Question: organization of documentation #355

creisle opened this issue Jul 29, 2019 · 0 comments

Comments

@creisle
Copy link
Contributor

creisle commented Jul 29, 2019

Is there a reason why the docs are store separately from the codebase?

Would you consider storing the docs for each repo with the code itself? At least for the drivers? It would be easier to tell what code works for what version then. In particular, this is currently a bit difficult when using the orientjs docs.

It would also be nice to have jsdoc style comments that could auto-generate docs. Then it would be easier to see function signatures etc.

If this is something you'd like to do I would be happy to help/contribute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant