Re: [Chicken-users] new egg documentation bootstrap

[Mario Domenech Goulart]

Hi Derrel

On Wed, 16 Dec 2009 11:37:16 -0500 Derrell Piper <address@hidden> wrote:

> I'm working on a new egg but I don't quite understand the
> documentation process.  Assuming I want to go with (doc-from-wiki),
> where do I go in the wiki to actually create the page?  And should I
> do that before or after I get an svn directory set up?

You should create a page by editing
http://chicken.wiki.br/eggref/<version>/<eggname>, where <version> is
the chicken major version (currently it is 4) and <eggname> is the name
of your egg.  Just point your browser to that location and start
editing.

You can document you egg at any moment, before or after getting the svn
directory.


> I'm also not sure I completely understand what's meant by this
> (cf. "eggs tutorial"):
>
> "Whenever a new release for your egg is made, its associated file from
> the wiki will be converted to HTML and shipped with it (as mpeg3.html)

That's true.


> as well as uploaded to
> <http://www.call-with-current-continuation.org/eggs/>."

I think that's outated.  IIRC, only chicken 3 docs go
http://www.call-with-current-continuation.org/eggs/


> Is that something that just happens automagically?  And what does that
> really mean today?  That sort of implies that I should have html for
> every egg I have installed but if I do, I don't know where that lives.

It's under $PREFIX/share/chicken/doc/html, where PREFIX is the path you
provided to `make' when building chicken.


> And if not, what's the point?  But regardless, I assume you don't want
> me to check in any html if the doc's in the wiki, right?

Right.  The html shipped with the egg is automatically put there.

Best wishes.
Mario