Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
-
e.g.:
- https://kubeblocks.io/
- https://github.com/apecloud/...
README.md's "What is KubeBlocks" contains everything I need to know. 3 paragraphs / 6 sentences ==> dead clear understanding of what it is, how it works, what it supports and whether or not I need it.
Compare this to the webpage's content.... -
You aren't wrong.. I've faced this problem of not understand the workings of the tool that I am trying to research and check the potentials of integration.
I think it's done on purpose to describe it as vaguely as they want, so that you'd submit a "Demo" request to their sales team at which point you're more likely to buy the product.
People who are not interested will walk away anyway, so the company doesn't see it as a loss. -
@netikras omg, you don't even need to type in the tutorial. You click a button and it types for you. Whehehe
-
Reminds me of cmdk. Great tool but utterly useless documentation.
https://cmdk.paco.me/
https://github.com/pacocoursey/cmdk
Found this in our codebase, apparently one of my co-workers had written this
This passes all unit tests
Why are project/tool webpages so useless...?
I mean, whenever I hear of a new tool/project I google its name. Of course, its dedicated webpage pops up as result #1. And EVERY TIME I find them looking nice, but quite confusing, riddled with all the buzzwords, nice phrases, promises of a better tomorrow,... but I'm yet to find a tool's webpage that explains what's that tool for and how to use it at least half as concisely and clearly as that tool's README.md in its GH/GL repo.
I mean, I can read every single word in the webpage, look at every picture/diagram, every fancy gif and still in absolute majority of cases I have no clue what that tool does.
Then I go to its GH/GL repo, read the first 2 sections of its README.md (takes me what, 2-4 minutes?) and I know all I need to now about the tool.
What's the point of those fancy webpages apart from containing docs and an SEO-tuned link to a README.md...?
Useless waste of storage and computing power if you asked me.
rant
pretty and dumb
repository
projects
not clear
tools
description
buzzwords
readme.md
useless
webpages