<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> </head> <body bgcolor="#ffffff" text="#000000"> Hi Hilaire, I don't have a strong opinion on the best way to document Cuis. I think a book would be great addition to the Cuis world, and I'm willing to help. I also think that is the license of the contents is appropriate, stuff we write could be reused in other forms (like active essays in the image). WRT to the table of contents, I'd add a preface explaining what Cuis (and Smalltalk-80) is all about, and as little space on technicalities as possible. For instance, I don't think that "Configuring Cuis Smalltalk environment" is needed, and would collaps Installing... and Starting... in a single hopefully short text. I'd also avoid waiting until "advanced topics" to tell a bit about Morphic. The UI and the environment are central to Smalltalk, and Morphic is central to Cuis. Just my 2 cents. Cheers, On 7/5/2020 3:05 PM, Hilaire Fernandes via Cuis-dev wrote: <blockquote cite="mid:da9fd822-8cd4-910d-815e-4be07111d127@drgeo.eu" type="cite"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> Hi, Cuis is documented with bits found there and there, it is not easy for new comers. Several time, after searching on Cuis or asking on the list, I felt like a want to write a small documentation notes on a recent finding so it can be useful for other. So far I didn't and it is a waste, pretty sure the same occurred to you as well. We already have <a class="moz-txt-link-freetext" href="https://github.com/Cuis-Smalltalk/Learning-Cuis" moz-do-not-send="true">https://github.com/Cuis-Smalltalk/Learning-Cuis</a> and also <a class="moz-txt-link-freetext" href="https://github.com/Cuis-Smalltalk/CodeExamples" moz-do-not-send="true">https://github.com/Cuis-Smalltalk/CodeExamples</a> with valuable contents! If I miss any, please tell. What about more structured documentation, like a book, (with content related to LeaningCuis and CodeExample). We could each other insert our knowledge in documentation notes into it. I think I could spend 30 min/day on such a project. IMHO, on-line editing with capability to output printed book, may be several ones, for Lulu will be a nice achievement by the community. It will give more visibility to Cuis too. Of course inserting documentation notes does not make a book but it gives valuable incentives and directions to expend in valuable documentation. Bellow my suggestions for a table of contents. We could insert into documentations note and expand it later as documentation paragraphs (we can capitalize on the Squeak/Pharo by Examples too, for some Smalltalk generic contents). Any opinion? Suggestion for the table of contents? At which place could we do the effort? Which tools to use? Hilaire <hr size="2" width="100%">A. Basic Cuis-Smalltalk <blockquote>Getting started </blockquote> <blockquote> <blockquote> Installing Cuis-Smalltalk Starting Cuis-Smalltalk Configuring Cuis-Smalltalk environment Writing your first script Introduction to the system class </blockquote> Writing your first application An excuse for a tour in Cuis world (Browser, Inspector) </blockquote> <blockquote>Understanding the basic Cuis' model <blockquote>Syntax Statements as blocks and messages send Basic classes Collections </blockquote> Writing your second application <blockquote>A second excuse for a tour in Cuis World (Debugger, Changset) </blockquote> Cuising with Style (aka best practices) <blockquote>Variable/Comments/Method/Scope/Refactoring... Common design patterns ... </blockquote> </blockquote> B. Advanced Cuis-Smalltalk <blockquote>Cuis-Smalltalk code management Going visual <blockquote>The Morph system Composing widget with layout Graphic vectors engine </blockquote> The object model Testing your code Streams Reflection .../... </blockquote> <pre class="moz-signature" cols="72">-- GNU Dr. Geo <a class="moz-txt-link-freetext" href="http://drgeo.eu" moz-do-not-send="true">http://drgeo.eu</a> <a class="moz-txt-link-freetext" href="https://pouet.chapril.org/@hilaire" moz-do-not-send="true">https://pouet.chapril.org/@hilaire</a></pre> </blockquote> <pre class="moz-signature" cols="72">-- Juan Vuletich <a class="moz-txt-link-abbreviated" href="http://www.cuis-smalltalk.org">www.cuis-smalltalk.org</a> <a class="moz-txt-link-freetext" href="https://github.com/Cuis-Smalltalk/Cuis-Smalltalk-Dev">https://github.com/Cuis-Smalltalk/Cuis-Smalltalk-Dev</a> <a class="moz-txt-link-freetext" href="https://github.com/jvuletich">https://github.com/jvuletich</a> <a class="moz-txt-link-freetext" href="https://www.linkedin.com/in/juan-vuletich-75611b3">https://www.linkedin.com/in/juan-vuletich-75611b3</a> @JuanVuletich</pre> </body> </html>