orientechnologies / orientechnologies/orientdb-docs
Keep explanations of features separated from java examples
Open
@santo-it is already working on this.
Since Nov 23, 2016.
enhancement
refactor
- Dominant language
- CSS
- Stars
- 59
- Forks
- 165
- PR merge metrics
- No merged PRs in 30d
Description
Important task to improve the documentation
When we describe / explain things, we should explain them assuming that the reader has no knowledge of java
We should explain how the things work in general and then we may add subsections to say how to do that specific thing with java, with SQL or using any other method
Right now too often we explain things adding java examples, or immediately mentioning java - things that should be avoided
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.
Assessment
This issue has not been assessed yet.