[Cuis-dev] Dr Cuis
Juan Vuletich
juan at cuis.st
Mon May 19 11:25:50 PDT 2025
On 5/12/2025 6:08 PM, Hilaire Fernandes via Cuis-dev wrote:
>
> Hi,
>
> Some update at http://github.com/DrCuis, the known documentation is
> spread in four categories
>
> --
> http://mamot.fr/@drgeo
Hi Hilaire,
I've had a quick look at the main 4 repositories:
https://github.com/DrCuis/Tutorials
https://github.com/DrCuis/How-to-guides
https://github.com/DrCuis/References-guides
https://github.com/DrCuis/Explanations
I think that Tutorials is OK. "Tutorials" is a meaningful subset of
"Documentation". I would expect this repo to grow to reflect the needs
and desires of new users an old users exploring new areas.
"How-to guides" also makes a lot of sense. However I would completely
remove the "Virtual Machine" section. Cuis-Smalltalk-Dev already
includes VMs for major platforms. 99% of Cuis users don't need to build
a VM. Helping the other 1% is fine, but I think that is "Pro Level"
documentation and it belongs somewhere else. Having that in the same
place as building packages or working with layouts may make people think
that hacking the VM is as important or frequent as doing packages and
layouts. Even worse. It may lead people to believe that building their
own package or using Layouts in their code is as difficult and "experts
only" as hacking the VM. We provide well tested VMs for most platforms
so people can forget about this as much as possible.
"Reference guides" is OK. I think that other reference material could
be added here. Perhaps the services offered by MorphicCanvas would
belong here. Or some comprehensive discussion about Unicode. I'm sure
there are many more that don't come to my mind right now.
"Explanations" looks like a place to put stuff that didn't belong in any
of the previous categories. Currently it includes both introductory
material, highly technical stuff, and lose bits of information. I think
this could be improved. For instance, separating "Philosophical" and
"Technical" material as done in Cuis-Smalltalk-Dev/Documentation, makes
sense to me.
Additionally, the question remains whether this should duplicate the
material in Cuis-Smalltalk-Dev/Documentation, or which parts belong in
DrCuis, and witch belong in Cuis-Smalltalk-Dev.
Thanks,
--
Juan Vuletich
cuis.st
github.com/jvuletich
researchgate.net/profile/Juan-Vuletich
independent.academia.edu/JuanVuletich
patents.justia.com/inventor/juan-manuel-vuletich
linkedin.com/in/juan-vuletich-75611b3
twitter.com/JuanVuletich
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20250519/07045b5a/attachment-0001.htm>
More information about the Cuis-dev
mailing list