I dont know about you guys, but personally I think the standard Rails
documentation leaves much to be desired. The blue header, the vanilla
code examples... the whole iframes thing. You can tell it was designed
by a programmer... which is not bad in and of itself, but as a
designer I feel the CSS and overall GUI needs some love.
Some ideas worth mentioning:
· Use of access keys (1-5 for top row 6-8 for bottom row)
· Live Search via AJAX
· Code snippets in color
· Clean, Legible Headers and heirarchy of data
CSS Style Switching
Theme #1 - Classic: Standard API style for those who like the old
Theme #2 - Shiny: Style that is consistent with 37 Signals and RoR
<img src="http://www.funkysoulrebels.com/rails/Yang.jpg" />
Theme #3 - Twilight: Inverted scheme for those of us who prefer dark
screens and light text. (see attachment)
<img src="http://www.funkysoulrebels.com/rails/Yin.jpg" />
The HTML/CSS for this is nothing I can'thandle.. the real challenge is
making rdoc spit out more customizeable code. I spoke to DHH about
this challenge and he really liked the ideas. His advice was to
connect with experienced Rubyists who would be willing to tackle the
inner workings of rdoc.
This post is my call-to-arms for any experienced programmers who would
be interested in giving the docs a well-deserved kick in the ass.
Any feedback/critiques are welcome.