orientechnologies / orientechnologies/orientdb-docs
Question: organization of documentation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 59
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names the orientjs documentation, driver docs, and JSDoc-style comments but no files or tests. Start by locating those documentation areas and clarify whether repo-local, versioned documentation and generated signatures are in scope; done would require an agreed documentation layout and generation approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100