orientechnologies / orientdb-docs

Repository of the entire OrientDB documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Question: organization of documentation

creisle opened this issue · comments

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