RailDock Version 0.7 Released http://raildock.mytechsupport.com/ Features and Fixes: - Now includes Ruby core documentation for convenience - Added a side-panel with AJAX drop-down boxes to navigate the site - Side-panel also includes a dynamically updated menu that comes from the wiki (you can edit the menu at http://wiki.rubyonrails.com/rails/ show/RailDockMainMenu) - Fixed some formatting bugs and width issues. Source Code: The source is now available, released under the open source Ruby license: http://raildock.mytechsupport.com/raildock-0.7.tgz Call for Action: For those of you who''ve been holding back until this was made open source, please do contribute by making notes and comments on the various methods and classes. I''d like to see a lot more examples and some quick-start-at-a-glance kind of information for all levels of Rails developers. Thanks again for all who''ve supported this project. Let''s make the Rails documentation as easy to use as the framework! Duane Johnson (canadaduane) _______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails
Richard Piacentini
2005-Jul-15 10:01 UTC
Re: [ANN] RailDock 0.7 - Time to start documenting
Great work Duane !! thanks a lot for the new release. while testing i found a little encoding problem, in the search listbox choose ''Bignum'' or ''String'', then ''%'' and the resulting url is: http://raildock.mytechsupport.com/ri/Bignum@% http://raildock.mytechsupport.com/ri/String@% Bad Request Your browser sent a request that this server could not understand. bests, Richard> RailDock Version 0.7 Released > > > http://raildock.mytechsupport.com/ > > > Features and Fixes: > - Now includes Ruby core documentation for convenience > - Added a side-panel with AJAX drop-down boxes to navigate the site > - Side-panel also includes a dynamically updated menu that comes from > the wiki (you can edit the menu > at http://wiki.rubyonrails.com/rails/show/RailDockMainMenu) > - Fixed some formatting bugs and width issues. > > > Source Code: > The source is now available, released under the open source Ruby > license: > http://raildock.mytechsupport.com/raildock-0.7.tgz > > > Call for Action: > For those of you who''ve been holding back until this was made open > source, please do contribute by making notes and comments on the > various methods and classes. I''d like to see a lot more examples and > some quick-start-at-a-glance kind of information for all levels of > Rails developers. > > > Thanks again for all who''ve supported this project. Let''s make the > Rails documentation as easy to use as the framework! > > > Duane Johnson > (canadaduane) > > > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails
Hi Duane, thanks for this effort. Really appreciated. Could you please darken (preferrably black) the font on the documentation pages? For example: http://raildock.mytechsupport.com/ri/ActiveRecord::Associations::ClassMethods@belongs_to I have trouble reading it. Thank you Sasa Ebach
A couple of questions: Is it possible to make method links from a class page link directly to that class method instead of getting to a list of every class that happens to implement that method? Is it possible to make the searches more "fuzzy"? Ie, when I search for ActiveRecord I get something about a sqlserver adapter. I have to actually search for ActiveRecord::Base to find what I was after. Often when searching for something I do it because I''m not aware of the exact spelling, what module it''s in, what casing used etc. I want to type "record" and get a list of hits where I can choose ActiveRecord::Base. I also tried to search for "string". Didn''t get me to the place I expected. "String" did. And the ajaxian popup in the search field isn''t perfect. When I type "Activ" and wait a couple of seconds I get a long list containing ActiveRecord::Base. If I type some letters more, "ActiveRecord:", then ActiveRecord::Base is no more an option. Why? /Marcus ps. I do however think that the concept is great. _______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails
while we''re at it -- also, its easier to read when the number of characters per-line is less. liquid is nice, customizable is nicer! Could you possibly allow for this? (i like 30 - 40 ems, but whatever) <style type=''text/css''> body { width: <%= session[''width''] || ''100%'' -%>; } </style> :) lovin the oss! On 7/15/05, Sascha Ebach <se-eFwX6J65rk9VioaHkBSlcw02NpfuEekPhC4ANOJQIlc@public.gmane.org> wrote:> Hi Duane, > > thanks for this effort. Really appreciated. Could you please darken > (preferrably black) the font on the documentation pages? For example: > > http://raildock.mytechsupport.com/ri/ActiveRecord::Associations::ClassMethods@belongs_to > > I have trouble reading it. > > Thank you > Sasa Ebach > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
Some more... It would also be nice if you could linkify class/module names when inside a method description. And it doesn''t seem that I can get to a class or module by using the dropdowns to the right? Only to methods? /Marcus ________________________________ From: rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org [mailto:rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org] On Behalf Of Marcus Andersson Sent: den 15 juli 2005 12:51 To: rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org Subject: RE: [Rails] [ANN] RailDock 0.7 - Time to start documenting A couple of questions: Is it possible to make method links from a class page link directly to that class method instead of getting to a list of every class that happens to implement that method? Is it possible to make the searches more "fuzzy"? Ie, when I search for ActiveRecord I get something about a sqlserver adapter. I have to actually search for ActiveRecord::Base to find what I was after. Often when searching for something I do it because I''m not aware of the exact spelling, what module it''s in, what casing used etc. I want to type "record" and get a list of hits where I can choose ActiveRecord::Base. I also tried to search for "string". Didn''t get me to the place I expected. "String" did. And the ajaxian popup in the search field isn''t perfect. When I type "Activ" and wait a couple of seconds I get a long list containing ActiveRecord::Base. If I type some letters more, "ActiveRecord:", then ActiveRecord::Base is no more an option. Why? /Marcus ps. I do however think that the concept is great.
Some more again: While searching with the dropdowns as follows: ActiveRecord -> Base -> find I got a list where "References to ''ActiveRecord::Base#find'' were found in the following methods and/or classes:" with no item pointing to "find" itself. Same result if I searched for "ActiveRecord::Base#find". I simply couldn''t get to that method. /Marcus -----Original Message----- From: rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org [mailto:rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org] On Behalf Of Marcus Andersson Sent: den 15 juli 2005 13:04 To: rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org Subject: RE: [Rails] [ANN] RailDock 0.7 - Time to start documenting Some more... It would also be nice if you could linkify class/module names when inside a method description. And it doesn''t seem that I can get to a class or module by using the dropdowns to the right? Only to methods? /Marcus ________________________________ From: rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org [mailto:rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org] On Behalf Of Marcus Andersson Sent: den 15 juli 2005 12:51 To: rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org Subject: RE: [Rails] [ANN] RailDock 0.7 - Time to start documenting A couple of questions: Is it possible to make method links from a class page link directly to that class method instead of getting to a list of every class that happens to implement that method? Is it possible to make the searches more "fuzzy"? Ie, when I search for ActiveRecord I get something about a sqlserver adapter. I have to actually search for ActiveRecord::Base to find what I was after. Often when searching for something I do it because I''m not aware of the exact spelling, what module it''s in, what casing used etc. I want to type "record" and get a list of hits where I can choose ActiveRecord::Base. I also tried to search for "string". Didn''t get me to the place I expected. "String" did. And the ajaxian popup in the search field isn''t perfect. When I type "Activ" and wait a couple of seconds I get a long list containing ActiveRecord::Base. If I type some letters more, "ActiveRecord:", then ActiveRecord::Base is no more an option. Why? /Marcus ps. I do however think that the concept is great. _______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails
Correction: If I did a textual search for "find" I actually found it. Although it would have been nice if I could get to it in the way I described before. /Marcus -----Original Message----- From: rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org [mailto:rails-bounces-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org] On Behalf Of Marcus Andersson Sent: den 15 juli 2005 13:18 To: rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org Subject: RE: [Rails] [ANN] RailDock 0.7 - Time to start documenting Some more again: While searching with the dropdowns as follows: ActiveRecord -> Base -> find I got a list where "References to ''ActiveRecord::Base#find'' were found in the following methods and/or classes:" with no item pointing to "find" itself. Same result if I searched for "ActiveRecord::Base#find". I simply couldn''t get to that method. /Marcus
Duane, Great job - /me likes. The site looks great in Firefox, but the code examples doesn''t render as i assume you meant it to in IE. the valid xhtml link suggest that there are some errors. The script also doesn''t work when trying to go to the docs for another method in the class. everything works great in Firefox though. the url I experieced the problems on (incase it is not a sitewide issue): http://raildock.mytechsupport.com/ri/ActionView::Helpers::JavaScriptHelper@visual_effect thanks again, *:f*rancois Duane Johnson wrote:> * > /RailDock Version 0.7 Released/ > / > / > http://raildock.mytechsupport.com/* > > *Features and Fixes*: > - Now includes Ruby core documentation for convenience > - Added a side-panel with AJAX drop-down boxes to navigate the site > - Side-panel also includes a dynamically updated menu that comes from > the wiki (you can edit the menu > at http://wiki.rubyonrails.com/rails/show/RailDockMainMenu) > - Fixed some formatting bugs and width issues. > > *Source Code*: > The source is now available, released under the open source Ruby license: > http://raildock.mytechsupport.com/raildock-0.7.tgz > > *Call for Action*: > For those of you who''ve been holding back until this was made open > source, please do contribute by making notes and comments on the > various methods and classes. I''d like to see a lot more examples and > some quick-start-at-a-glance kind of information for all levels of > Rails developers. > > Thanks again for all who''ve supported this project. Let''s make the > Rails documentation as easy to use as the framework! > > Duane Johnson > (canadaduane) > > >------------------------------------------------------------------------ > >_______________________________________________ >Rails mailing list >Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org >http://lists.rubyonrails.org/mailman/listinfo/rails > >
Wow. I went to RailDock, did a search for "find" and Safari crashed. Anyone else having problems? (OS X 10.4.1) Todd Breiholz
Hey Todd. I just tried that out and had no problems. I am using OS X 10.4.2 however. You might want to upgrade to the newest version of OS X. Cheers Todd Breiholz wrote:>Wow. I went to RailDock, did a search for "find" and Safari crashed. >Anyone else having problems? (OS X 10.4.1) > >Todd Breiholz >_______________________________________________ >Rails mailing list >Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org >http://lists.rubyonrails.org/mailman/listinfo/rails > > > >
Hi Duane, Two things: I. On some pages, like on http://raildock.mytechsupport.com/ri/ ActionView::Helpers::JavaScriptHelper@visual_effect the examples are missing (they''re in the HTML code, but not visible). II. I''ve a suggestion for the front page: 1) make the search field bigger and use the same layout as on the subpages 2) between the search field and the most recent comments, add a tag soup, consisting of the 50 or so most often visited pages with the fontsize corresponding to the popularity. this would a) provide a self-organzing way to have the most-often requested docs availlable with one click, and b) (maye) help to identify problematic functions in Rails. Thanks for the site, it''s really cool. Thomas