On 8/21/05, James Britt <jbritt@xxxxxxxxxxxx> wrote:
> My current thinking is to alter the rdoc template so that core and
> stdlib API rdoc content pages have a means for transcluding plain old
> wiki content, most likely by using some AJAXy thing. Fetch the matching
> wiki page and insert the wiki page text.
>
> Regenerating docs from updated source code won't lose comments.
>
> Comments can be controlled though standard wiki tricks without having to
> worry about being couple to the Ruby source.
>
> It seems a reasonable, quasi-low-tech way to get nice features. No
> complex engineering.
>
> Folks with JavaScript turned off can see a link to the corresponding
> wiki comment page.
>
> It may also make things easier to migrate if and when someone comes up
> with a better rdoc template than the current multi-window framed thing
>
> Thoughts?
The easiest way which will work Right Now without cripping future
endeavours is definitely the way to go!
|
