orientdb-docs icon indicating copy to clipboard operation
orientdb-docs copied to clipboard

Keep explanations of features separated from java examples

Open santo-it opened this issue 9 years ago • 1 comments

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

santo-it avatar Nov 23 '16 18:11 santo-it

see also https://github.com/orientechnologies/orientdb-docs/issues/269

santo-it avatar Mar 21 '17 11:03 santo-it