Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

Documentation Lacking

#7

Sure, the RDocs are nice and pretty thorough, but are not proper documentation. They simply provide API documentation and should be tailored to such an approach.

However, proper documentation detailing how requests are handled, the internal and exposed architecture are designed, relevant information for actual implementation into existing projects, references, etc need to be created in a good, easily (by humans) parse-able format.

Documentation can be split up into two distinct sections, Client and Server.

Reported by Matt Todd · January 19th, 2008 @ 10:57 PM

State: resolved
Milestone: Release 0.5.0
Assigned to: Matt Todd Matt Todd

Activity

  1. Matt Todd
    Matt Todd
    • Milestone changed from Release 0.4.0 to Release 0.5.0
    • State changed from new to open

    Moved to 0.5.0 as 0.4.0 is now a maintenance/minor feature update.

    February 10th, 2008 @ 10:26 PM

  2. Matt Todd
    Matt Todd

    This ticket is almost too obvious to leave open but too needed to close... hmmm... And where to put said documentation? The GitHub wiki? Static HTML on http://halcyon.rubyforge.org/docs/ perhaps? Hmm.

    March 7th, 2008 @ 01:58 AM

  3. Matt Todd
    Matt Todd
    • State changed from open to resolved

    With the website going from pure HTML to generated HAML to a full Webby website, the structure has been put in place and actual documentation has been done. I don't believe keeping this ticket open anymore is necessary because articles have been planned out and contributed to with a good idea of how and what to continue with.

    http://halcyon.rubyforge.org/docs/

    April 4th, 2008 @ 05:57 AM

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.