James Edward Gray II wrote:
On Aug 21, 2005, at 7:46 PM, Benedikt Heinen wrote:
What I'm thinking about would be to build a wiki that doesn't store
individual wiki pages, but rather generates the wiki pages to be
displayed straight from checked out rdoc; and changes to the wiki
page would be written back into the source and committed back into
the source repository.
My opinion is that being able to comment on documented methods solves
this problem and I believe that feature is planned.
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?
James
|
