search

ostafen / clover

A lightweight document-oriented NoSQL database written in pure Golang.
MIT License
680 stars 55 forks source link

Improve existing documentation #20

Closed ostafen closed 2 years ago

ostafen commented 2 years ago

Several additions and functions have been added for the v1.1.0 release. It is important to improve the structure of existing documentation, also adding missing sections.

ostafen commented 2 years ago

Last commit (3dbb312075d40e986d8c0319cbe337614a112258) added a more curated documentation in the README. I will leave this issue open for a while, in order to collect further suggestions.

Aso, the chinese and spanish versions of the README should be updated @ASWLaunchs, @jsgm

jsgm commented 2 years ago

Now the documentation feels much better. I'll wait until the v1.1.0 is released for translating so we can change as many things we need.

For future versions greater than v1.1.0, once the library is more stable we could create a gitbook -or any other similar tool-, or simply a website and export the documentation there from the git repository.

Also just a minor detail, I use the dark version of Github and I can't see the logo

ostafen commented 2 years ago

Also just a minor detail, I use the dark version of Github and I can't see the logo

If you refer to the "clover" black part of the logo title, I'm aware of this issue. But I don't find any color which is suitable both for dark and normal version

jsgm commented 2 years ago

Also just a minor detail, I use the dark version of Github and I can't see the logo

If you refer to the "clover" black part of the logo title, I'm aware of this issue. But I don't find any color which is suitable both for dark and normal version

Found a way to fix it. Please check the PR: https://github.com/ostafen/clover/pull/21 and how it would look after merged here: https://github.com/jsgm/clover