[Cuis] Documentation folder (was Re: HowToAnalyseAMorphicGUI.md)

[H. Hirzel]

Hello Juan

On 5/4/14, Juan Vuletich <juan at jvuletich.org> wrote:
> Hi Hannes,
>
> On 4/26/2014 5:46 PM, H. Hirzel wrote:
>> https://github.com/hhzl/Cuis/blob/master/notes/HowToAnalyseAMorphicGUI.md
>>
>> Feedback?
>>
>> --Hannes
>
> I think this is really nice and useful!
>
> We can open a folder named Documentation inside
> https://github.com/Cuis-Smalltalk/Cuis-Smalltalk-Dev , to store
> tutorials, how-to's, etc. Right now we have this piece and

> NotesOnMorpihc from you,

> http://www.cuis-smalltalk.org/CodeManagementInCuis4.html and

> http://www.cuis-smalltalk.org/CuisAndGitHub.html that are in html and in
> a style that is not consistent with the Git Hub repo, and I'm sure
> several others. I'd like to have all them in markdown, and inside the
> github repo.
>
> Thoughts?

Yes, going for a 'documentation' folder with Markdown documents is fine.

As for me browsing through

    https://github.com/Cuis-Smalltalk/Cuis-Smalltalk-Dev/tree/master/Documentation

is fine for the upcoming months

Later we can convert the markdown to html with a markdown converter like pandoc

       http://johnmacfarlane.net/pandoc/README.html

and add the html files to the gh-pages branch. Pandoc has a lot of
options including one to generate presentations from markdown.

I am thinking of a one-page index.html web site with a well known CSS
framework which opens additional documents coming from different
origins in separate windows. Or a one-page web site which uses a
position: fixed  <div> for the navigation (left hand side).

Then they will be visible through github.io

To summarize:
a) focus on content in markdown in a 'Documentation' folder.

b) It is very fine with me if you move
https://github.com/hhzl/Cuis/blob/master/notes/HowToAnalyseAMorphicGUI.md
to a doc folder in the main cuis repo. Then I can delete
github.com/hhzl/Cuis because I do no longer need it (4.1).

c) Later with some small additional effort the content may be
presented  formatted nicely.


Regards
--Hannes