Documentation - Githubissues

bio4j / dynamograph

GSoC 2014 project - a DynamoDB based graph DB

GNU Affero General Public License v3.0

4 stars 1 forks source link

Documentation #43

Closed alberskib closed 10 years ago

laughedelic commented 10 years ago

A minor structure suggestion:

Merge Overview and Index together and call it Readme.md. Then it will be seen when browsing the doc/ dir and it's more convenient for navigation

eparejatobes commented 10 years ago

Hey @alberskib I took a look at this, I like the general structure and organization, and the content is OK.

alberskib commented 10 years ago

Great there is still some subpages that needs completion - I am working on it

eparejatobes commented 10 years ago

hey @alberskib I took a look at this. I fixed some typos and minor grammar mistakes; there are more, but they are pretty similar to those I fixed, look for them!

It's all good in general. Things that you need to pay attention to are

be sure that it reflects the current codebase
try to refer to elements in a consistent way (db, database, DynamoDB)

eparejatobes commented 10 years ago

also, I'd mention in the readme GO as an example etc