Re: Project Start: Section 1

Michael Lazzaro wrote:

>OK, let's start on the first section (calling them "Sections", not
>"Chapters").  As our first experiment, we will assume a treelike style
>(section 1 --> 1.1, 1.2, 1.2.1, etc.); look at
>http://www.mysql.com/documentation/ for an example of a good, detailed
>documentation tree.
>
>So let's go depth-first into a single section, and see what we learn.
>

<snip>

>TASK 1b:
>
>Determine the presentation of the material, i.e. come up with a strawman
>design for how the material will look in each of these cases:
>
>        -- as online documentation
>        -- as manpages
>        -- in other (printable) forms
>        -- as executable test cases
>  
>

I really like the current perldoc.com appearance.
Couldn't we just use that? (for now, at least)

<snip>

>TASK 1d:
>
>Determine how perl6-internals would best like to receive test cases
>associated with this documentation, and what mechanism we will use to
>produce those tests.
>

I think exactly how /parrot/languages/perl6 has it now.  Since
/parrot/languages/perl6 is the prototype compiler, I assume that the final
version will mirror it closely.  That way, we can also recycle all of the
tests already there.  (Oh, it uses a Test::Harness schema by the way.)

On another note, is there place (CVS) that can be set up that this stuff can
uploaded this stuff to? :)

>---
>
>If you wish to assist in any of these tasks, please declare your intent
>to do so on this list, then just have at it, posting your proposals here
>ASAP.  We've already informally started task 1a, for example.
>  
>

I can start writing tests for the Section 1 material, but I'd rather 
wait for
the outline to be finished before I start writing manpages.