2 ms·
Thanks for your sharing. I was ever working actively on Apache Kvrocks, an alternative for Redis on Flash. And we benefit a lot from Redis docs to catch up its
by tison 3y ago
Thanks for your sharing.
I was ever working actively on Apache Kvrocks, an alternative for Redis on Flash. And we benefit a lot from Redis docs to catch up its command. In comparison, Kvrocks docs is clearly "less than awesome".
In my $DAYJOB, I convince my boss that the docs, at least the README is important, as you show the esbuild example here.
Here are two patches to improve the README of it:
* https://github.com/GreptimeTeam/greptimedb/pull/3528 https://github.com/GreptimeTeam/greptimedb/pull/3528
* https://github.com/GreptimeTeam/greptimedb/pull/3522 https://github.com/GreptimeTeam/greptimedb/pull/3522
That in #3522 firstly, I tried to reduce the content and "offload" the detailed docs into the doc site. And in #3528, I found that heading elements center align is still fancy and we need some short, clear introduction and advantages.
Anyway, a good product is the leading 1 and docs is the following 0. Without a good product, no good docs can be present.