Re: [Chicken-users] egg documentation

[Peter Bex]

On Tue, Feb 12, 2008 at 11:10:28AM -0600, Ozzi wrote:
> This is perhaps a different concern, but I wonder if there would be value in 
> designating certain eggs as "part of" Chicken, and holding these eggs to a 
> stricter standard of documentation.

Why do you want to make a distinction?

The whole point of the note on the wiki was that we need _one_ documentation
system.  The current system sucks, because you keep switching interfaces.
Say you're looking for some documentation, so you search using the wiki
system.  However, the docs you're looking for happen to be written in eggdoc
or the legacy HTML documentation.  Besides not being able to search these
docs, when you visit them, you go to another site and you lose the
navigational tools you get in the wiki.

Visually it's also confusing, because the three docs look different.  This
last point might sound trivial, but I'm sure when a potential new user is
browsing for a new scheme implementation, he's might get scared away just
because he has no idea why some docs are on this site, some on that and why
they look and act differently.  I know Chicken is a "hacker's scheme", but
there's no point in alienating people.

So, to conclude, I don't mind _what_ we're going to do, as long as it's
consistent and pleasant to use (both as doc author and reader).

Cheers,
Peter
-- 
http://sjamaan.ath.cx
--
"The process of preparing programs for a digital computer
 is especially attractive, not only because it can be economically
 and scientifically rewarding, but also because it can be an aesthetic
 experience much like composing poetry or music."
                                                        -- Donald Knuth

pgpWSRbydE6VK.pgp
Description: PGP signature