1201
Open source devs: please, please add screenshots...
(lemmy.world)
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
this post was submitted on 14 Aug 2023
1201 points (97.8% liked)
Open Source
31181 readers
225 users here now
All about open source! Feel free to ask questions, and share news, and interesting stuff!
Useful Links
- Open Source Initiative
- Free Software Foundation
- Electronic Frontier Foundation
- Software Freedom Conservancy
- It's FOSS
- Android FOSS Apps Megathread
Rules
- Posts must be relevant to the open source ideology
- No NSFW content
- No hate speech, bigotry, etc
Related Communities
- !libre_culture@lemmy.ml
- !libre_software@lemmy.ml
- !libre_hardware@lemmy.ml
- !linux@lemmy.ml
- !technology@lemmy.ml
Community icon from opensource.org, but we are not affiliated with them.
founded 5 years ago
MODERATORS
Me, developing a headless component library:
To be that dick, a headless component library is still meant to do something, show an example of it being used!
What would the world even be like without people feeling the need to be a dick about an obvious joke ๐
If you've written a "usage" section that showcases more than one uselessly simple example that doesn't even work in the project's current state, you're already far ahead of the average.
This is how I generally write documentation for my projects: https://tybalt.org
Even for a CLI tool, there should be a real world example showing how it works and what the output looks like. Eg, for jq:
And a few other examples.
I feel like maybe you don't know what a headless component library is. A cli has a head -- the terminal. Headless applications, by definition, have no visual portion. For instance, a headless browser is a browser where the web page renders in-memory, but never displays any content. A headless component library, then, is one where the implementor doesn't provide anything visual, only behavior. For web dev, is very helpful -- the library implementator writes all the js, but the css and html (the "head") are left to the user for use. The best headless component libraries, then have nothing to screenshot without the user supplying some implementation.