[documentation] API documentation for dev, not docs?

[Anisa]

Thank you for your email.  I was wondering where this 'Documentation in CVS'
was.  ^.^;;  I suppose it's IN a CVS somewhere, but you find it in
api.drupal.org, not cvs.drupal.org.  It didn't seem very userfriendly to
actually have docs in the cvs...

To find a reference to the quick start guide in the handbook, though, I had
to dig down deep.  Not good.

Beside the point, though.  Do both stay?  Both go?  One go and one stay?

I can't decide for anyone, because hey, like I'd make a patch.  ;p  But it
would be nice for it to be decided...  I like cleaning up things (like bug
queues) when I am bored and should be doing something else.

Anisa.



On 6/22/06, Heine Deelstra <info at ustilago.org> wrote:
>
> On Tue, 20 Jun 2006 08:55:31 +0200, Anisa <mystavash at animecards.org>
> wrote:
>
> > So, on one issue, I think it was something about the form textfield
> > something or other (http://drupal.org/node/19441), I was simply updating
> > the
> > link to the new API, and Dries said that, quote "The only way to fix API
> > documentation, is by submitting a patch against
> > Drupal core.  This is not an issue for the documentation team so feel
> > free
> > to move it to the Drupal project instead."
> >
> > So, that makes sense to me, OK, but I know I've seen API issues moved to
> > docs because it was documentation so what's the consensus?  If we can
> all
> > agree, then http://drupal.org/node/24572 should be updated.  There are
> > maybe
> > half a dozen API issues in docs not getting much love, I wouldn't want
> > them
> > to just get shifted to dev, only to have a dev person say this is docs.
> > It'd be kinda silly.
>
> Hi Anisa,
>
> There are actually two parts to documentation in CVS; the autogenerated
> API docs (from certain comments) and the docs that reside in CVS. The
> first can only be updated with a patch to core, because the core code
> contains these remarks and docs are generated from it. The second can be
> updated by generating a patch against the documentation files itself.
>
> See for example http://drupal.org/node/70027
>
> Regards,
>
> Heine
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



-- 
*********************************
www.AnimeCards.Org

16,000 scans and counting!
*********************************
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20060621/8afbce95/attachment.htm