The hard part about creating open source software is finding people to write the documentation; developers tend to explain their functions with their functions.
(glowBlue() -> makes the object glow blue)
People who do that are rare and in demand, even in corporate scenarios; we searched for one for months. It’s even harder to find people to write docs for FLOSS projects because they can’t always be paid.
On a side note, anyone interested in helping with CodiMD docs? 😁
"Indeed, I have a new feature in <software> for months now, but I don't know how to use it or even what it is… cause… well… documentation… 📜"
Remember: #Documentation is important. If it is missing for a bigger feature either other devs or even users may not be able to even use it. 🤔
📺 Suivez les journées @com_abes (28-29 mai) en ligne et en direct ➡️ https://t.co/XzhF2Z0CGh
Dear sphinx-doc devs;
I know, I've been (still am) that dev who is convinced some missing feature is wrong headed and/or not worth the trouble. On the other hand, when there are multiple user extensions floating around with names like "fixed_only" and "sane_only", maybe it's time to reconsider how the 'only' directive works in sphinx-doc.
The most important endpoints are now documented, you can send real requests to our demo server and inspect the responses to have a better understanding of how it works!
You can even use it to interact with your own instance ;)
If you do, there's a job waiting for you as a technical editor. Let me know if you apply and I'll officially refer you.
@.@ Just read the Signal changeset for the URL previews:
Wonderful how they ehhh not document their source code. There are exactly 7 comments in the entire changeset of more than 2600 lines of code. ~2000 of them are added.
I'm not sure that's a good sign…
Author: "[Code] Comments are Evil [..] they can be avoided and instead you can focus on doing a better job of naming things."
Reasonable discussion below the article:
user: "what about THESE type of comments?"
author: "oh yea, those are great and indispensable. but i don't consider those comments to be comments."
I've always considered myself an old school hacker, in the creative sense of the word, separated from the others by the void, and the forces of time.
Here, I'll post infrequently about the following topics:
I may also, from time to time, talk about my attempts to recapture some of the spirit of university mainframes.
Mhm, looks like I discovered an undocumented, unbelievable awesome feature in CodiMD 😳
Looks like we have a completely working reveal renderer for live editing your slide shows implemented. It's just not documented how to turn it on.
See the little difference between the editor mode:
Without type slide:
With type slide:
I love help new users! But web dev is tough, so I don't come down too hard on the #gohugo docs. The project is always moving forward, and we have a lot of hidden presumptions: git, server hosting, knowing basic web dev.
It's a moving target, but I'm optimistic. Also, #documentation writers are a thing, yo!