Kb – a minimalist CLI knowledge base manager https://github.com/gnebbia/kb

github.com

2 points·bombadil09··5 comments

I think you meant to link here https://github.com/gnebbia/kb

kb v0.1.6 is out with many new features!

It looks cool, like I may well want to use it.

The github page doesn't seem very good at introducing new users though. It suffers 100% from the "curse of knowledge". There's a lot of GIFs of stuff being done, but I found it was impossible to learn anything from those, they move too fast, and don't explain what they're doing. There's just a few lines of text in between each, which don't explain really what or why, either. What are the basic..data structures? How do I use it, in the simplest case? I don't know the answers to these, after scanning many pages of text on that page. Something taking me through a first session using it would be very helpful. The software is proclaimed to be quick and simple...but the documentation managed to be lengthy, frustrating, and no help at all. I gave up.

For example, "Usage" looks like where you'd start, but there are 3 GIFs with something being done, I can't tell what, and it's not explained. That's all there is in "Usage". Next is "List artifacts" - but it hasn't explained what artifacts are, or how to create them. Why would I read further? It seems just more of the same.

Thanks for the comments, these are very appreciated! What about adding a small section called "Short Tutorial" which walks the user into adding a file to the knowledge base, editing it and viewing? Do you think this may be ok? Would you like to contribute/help for this small section? We can work on a small markdown file.

Hi :-) , yes that sounds good. Sure I'd like to contribute/help. Hopefully you can decipher my email from my page.

Reply on news.ycombinator.com