[Cuis-dev] On the importance of Documentation ! Even tiny one.
Eric Sessoms
coder5506 at pobox.com
Sun May 18 04:26:55 PDT 2025
On Sun, May 18, 2025, at 4:29 AM, Hilaire Fernandes via Cuis-dev wrote:
> Hannes and I spend several hours thinking how to design a documentation
> system for the benefit of Cuis. It is in place, it is easy to navigate
> in, it is easy to contribute, it is easy to write down incomplete notes.
> There is no excuse.
Um... _how_?
Yes, I am one of the 200 lurkers you called out in your "Time to give back!" message a couple of months ago. Guilty as charged. But at the risk of sounding like a troll, I can't find any documentation on how to contribute to the documentation.
I've been following the documentation project on the mailing list. I think it's great, but I have no idea how to get started. There was mention of a wiki, which I found encouraging because public wikis are a convenient, low-overhead way to contribute small bits of documentation.
> One things still to be done is to set a wiki to write down technical
> notes. There are a lot of Questions ans Answers in the list that it is
> worth to write somewhere.
That doesn't seem to have been realized yet. I've seen links to a couple of wikis, but neither is editable.
> https://github.com/nmingotti/The-Cuis-CookBook/wiki
> http://95.179.246.60/mediawiki/index.php/The_Cuis_Cookbook
And a few days ago there was this note in a different thread.
> we (Juan, Ken or I) can add you as member in the DrCuis organization
> to gain writing access
I'm left wondering: Will there be a wiki? Where? Should I preemptively ask to be added to the repositories? The organization? Do you want pull-requests? Issues? The fact that I don't know how I'm expected to contribute is a barrier to getting started.
Maybe you have already addressed all these questions and I'm just blind or an idiot (can never rule that one out) but I'm unable to find the answers.
Could I request, please, a how-to guide https://github.com/DrCuis/How-to-guides on contributing to the documentation, preferably linked-to from the organization's readme https://github.com/DrCuis ?
More information about the Cuis-dev
mailing list