[Cuis-dev] Documenting Cuis

Gastón Caruso gstn.caruso at gmail.com
Sun Jul 12 11:20:20 PDT 2020


Hi all, I've read the thread and I just wanted to remind you that
https://cuis-smalltalk.github.io exists.

I'll attach the script I used to generate that site (probably you'll want
to rename the DocGenerator>>#outputDirectory method); but basically what
that code does is to pull all the source code from the image and output
several markdown files.
I've manually pushed the result to the cuis github page repository. I think
that maybe we could include some extra content and we could use the github
page that already exists.

I think that books served as static sites are quite useful and a lot of
communities are using them, see for example the rust lang book
<https://doc.rust-lang.org/book>.

What do you think?

Cheers,
Gastón

El jue., 9 jul. 2020 a las 11:34, Mariano Montone via Cuis-dev (<
cuis-dev at lists.cuis.st>) escribió:

> El 9/7/20 a las 10:20, Mariano Montone escribió:
> > El 9/7/20 a las 04:55, Hilaire Fernandes via Cuis-dev escribió:
> >> Hi Mariono,
> >>
> >> IMHO, you will make Erudite even much more interesting for Cuis and Cuis
> >> application developer by extending its importation capabilities.
> >>
> >> For example, for DrGeo the user guides are written with Texinfo wich can
> >> export to several documentation output formats (html subset, dvi,pdf,
> >> docbook, xml, info). The import could be made so that @code fragment
> >> will be converted as dynamic media to execute Smalltalk code.
> >>
> >> Likely more work but it will have a more direct impact.
> >
> > Yes, that'd be more work.
> >
> > Perhaps I should implement the import from one of them, let's say the
> > easier, xml probably. And the user can then use 'convert' linux command
> > or similar to convert his document to that format first, and then import
> > to Erudite.
>
> I'm liking docbook format. Both for import and export formats. It is
> easy to process and can be converted to and from any other format.
> --
> Cuis-dev mailing list
> Cuis-dev at lists.cuis.st
> https://lists.cuis.st/mailman/listinfo/cuis-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20200712/14cd2b92/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Cuis-Documentation.st
Type: application/octet-stream
Size: 3822 bytes
Desc: not available
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20200712/14cd2b92/attachment.obj>


More information about the Cuis-dev mailing list