This page is part of the ongoing DocumentationDiscussion
Some notes about the suitability of Hieraki as the basis for \RoRDoc.
WikiGardening required. This document was (roughtly) cut out of DocumentationDiscussion and could use a good scrubbing down.
LeeO: I propose that Hieraki(http://hieraki.org/) be used as the basis for a centralized, managed Ruby on Rails manual. Hacking/expanding will definitely be required (see “Using Hieraki for \RoRDoc?” above), but I think it makes more sense to use the foundation already available.
Hieraki still needs
- Import from RDoc xml
- Meaningful URLs (aka NiceLinks?)
- Persistence between versions/imports
- User comments
- search
Sticking Points?
- -URL structure- (no longer a sticking point as of 0.11!)
- Updating info
- Move comments?
- Orphaned comments
- Multiple projects on one server? ex. Rails = AR, AP, AM, etc.
- Comment moderation/admin