codenotary / immudb

immudb - immutable database based on zero trust, SQL/Key-Value/Document model, tamperproof, data change history
https://immudb.io
Other
8.54k stars 340 forks source link

review immudb product documentation #493

Closed vchain-us-mgmt closed 3 years ago

vchain-us-mgmt commented 3 years ago

Check if documentation is complete and understandable

dxps commented 3 years ago

Hi!

I would like to contribute here as currently I am starting to evaluate it and thus playing with it. At the same time I am quite picky on the details and consistency, so here I am... 😊 starting with some initial feedback.

First, this issue's scope has already being addressed in issue #472 Review product immudb product documentation, so you may want to close that one.

Second, in How it works > Checking data consistency, the diagram needs small updates:

I could update the diagram if I have the source of it or simply create a new and similar one.


And thanks for this nice product! 😊

jeroiraz commented 3 years ago

Thanks @devisions for the detailed review and findings. I've just updated the diagram. Please feel free to make a new one, and we can include the source for collaborative updates.