PIR user documentation
Allison Randal
allison at parrot.org
Wed Nov 19 07:38:41 UTC 2008
Klaas-Jan Stol wrote:
> hi,
>
> for 1.0, user documentation should be finished for PIR. In docs/art,
> there are three very nice articles on specific details of PIR.
> I would suggest that we investigate what these articles explain, define
> a list of features not described, and add a number of articles to
> complete the user documentation of PIR.
> In that process, it is probably necessary to review and update the
> currently existing articles in docs/art.
Updating and cleaning up existing documentation is a great approach.
We need a single, consistent location for user documentation, so new
users don't have to dig all over the repository to find things. (Who
would have thought to look in docs/art for the details of PIR?) I
suggest that we add docs/user, and that those 3 articles be renamed
something like docs/user/pir/getting_started.pod,
docs/user/pir/pmcs.pod, and docs/user/pir/objects.pod.
Allison
More information about the parrot-dev
mailing list