[Grok-dev] Re: Possible sprint topics

Luciano Ramalho luciano at ramalho.org
Tue Sep 11 18:34:32 EDT 2007


On 9/11/07, Martijn Faassen <faassen at startifact.com> wrote:
> > * Reference documentation.
>
> Very important! I hope we can get some reference documentation published
> online, in part based on the admin UI.

Yes, the great thing about publishing the reference documentation
online will be enabling users to add comments and examples directly to
the documentation pages, similar to what they have in the PHP
reference and in the Django Book:

http://www.php.net/manual/de/ref.dir.php

http://www.djangobook.com/comment-help/

The PHP community have been doing this for ages. A lot of the value in
the PHP docs is in the user comments. And probably 90% or more of the
API usage examples are user provided.

Cheers,

Luciano


More information about the Grok-dev mailing list