[Cuis-dev] On the importance of Documentation ! Even tiny one.

[ken.dickey at whidbey.com]

On 2025-05-18 04:26, Eric Sessoms via Cuis-dev wrote:
> 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'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.

Eric,

Thanks for showing up and posing interesting questions.

We all suffer from busy lives.  It is very useful to get all the help we 
can to share what we know and how to discover what we don't.

Another consideration is to refer to, if not combine, the multitude of 
ways people are attempting to address this situation.

If you look at
   https://github.com/DrCuis/Learning-Cuis/blob/master/README.md

You will note references to work of Dr Nicola Mingotti and Mark 
Volkmann.  We also have Cuis-doc-in-Cuis tools, Class Comments, Package 
Installer, an so forth.

As the Cuis Community grows, just making sense of this to channel people 
of different backgrounds and expectations into useful, orienting, and 
productive learning is a challenge.

I look forward to thoughtful suggestions.

Please lurk more loudly!  8^)
-KenD