Hi, Offer Kaye wrote: > Following the release of Rakudo Star I've been playing around with > learning Perl 6 and noticed a distinct lack of user-facing > documentation. After some IRC chats with pmichaud++ I thought it would > be a good idea if I got the ball rolling, assuming of course it > doesn't reach a sharp incline, roll back and squash me.
I appreciate your effort, and will help wherever I can. > Attached are a 3 very initial (skeletal in nature) Perl 6 .pod > documents, based loosely on the Perl 5 documentation. It is my > understanding that currently there is no P6-Pod reader e.g. "perl6doc" > so these are actually written in P5-POD, but the intent is to > eventually of course translate them to P6-Pod. Agreed. > My purpose is to get very initial feedback, see if this is the right > direction to go at all, get some thoughts on basic terminology, stuff > like that. For example: > 1. Use P5 POD or insist on P6 Pod? p5pod is good for now. > 2. Is it "Perl 6" or just "Perl"? Currently it's "perl6" but will it > be just "perl" eventually? I'd use 'Perl 6' in the title, and then refer to it as 'Perl' in the body of the document. > 3. Can I just rename S26.pod to perl6pod.pod and be done with it? :) S26.pod is intended as a reference (but quite readable, if I remember correctly). It's certainly a good start, maybe at some later point we might want to have something more tutorial-style. For what it's worth, there's an initial effort to get some documentation going in http://svn.pugscode.org/pugs/docs/u4x/ (look in the README for the vision, and documentation/ for some existing POD files). The rendered documents are at <http://doc.perl6.org/>. Certainly needs a better index file and some pre-text, but it's a start. You're welcome to add your stuff there (ping me or other Perl 6 hackers about a commit bit on #perl6), or start your own repo somwhere (though I'd prefer it not to have too much fragmentation, so if you do, just hand out commit bits liberally, and copy the u4x stuff over to the new repo. masak, is that OK for you?). Cheers, Moritz -- Moritz Lenz http://perlgeek.de/ | http://perl-6.de/ | http://sudokugarden.de/
