Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: Omniref - a better search site for Ruby documentation

omniref.com

Post reply on HN
Print view View original

11–20 of 63 posts

Re: Show HN: Omniref - a better search site for Ruby documentation

#11

Post by montanalow »

yale wrote: post #4

Looking great. My only wish would be having a list of constants and methods in the sidebar after selecting a class or module.

Right now, the Table of Contents navigation is only visible on full documentation pages, but I'm working on some javascript to make it work in a nice way for the search results previews too. Also working on making it more obvious how to get to the full doc pages as well.

Re: Show HN: Omniref - a better search site for Ruby documentation

#12

Post by timr »

derwiki wrote: post #7
montanalow wrote: post #2

Tim & I are planning to spend quite a bit more time on this, what do you other devs want to see in documentation search? Full stack? Multi version? Comments? Examples? IDE integration? What would make your life better?

Enumerate options that are obscured by inheritance. For example, to look at: http://www.omniref.com/?q=cache_action I don't know what options are valid in `cache_action`. The "real" answer, AFAICT, is to keep walking up the source code until you find the AbstractWhatever that actually defines the options.

Yeah, rails makes this as hard as possible to figure out, because everything is done dynamically by Hash arguments. Maybe we can do something like like link up the inheritance tree from the method?

Re: Show HN: Omniref - a better search site for Ruby documentation

#17

Post by atmosx »

montanalow wrote: post #2

Tim & I are planning to spend quite a bit more time on this, what do you other devs want to see in documentation search? Full stack? Multi version? Comments? Examples? IDE integration? What would make your life better?

I would like to have code examples in many libraries. But I'm not sure how you could achieve this... Maybe linking stackoverflow related posts in some way.

Re: Show HN: Omniref - a better search site for Ruby documentation

#19

Post by timr »

emmett wrote: post #15

Improved crossreferences! The main problem with Rails docs today is that methods mention other methods by name, but there's no way to jump directly to that other method.

It's pretty tough to always know the right method in the general case (e.g. method from another module), but we think have some ideas that we're working on that will greatly improve this.

If nothing else, we can trigger a search for methods with that name. We're going to do that very soon, actually.

Re: Show HN: Omniref - a better search site for Ruby documentation

#20

Post by JonnieCache »

montanalow wrote: post #2

Tim & I are planning to spend quite a bit more time on this, what do you other devs want to see in documentation search? Full stack? Multi version? Comments? Examples? IDE integration? What would make your life better?

Load the rdoc for all of rubygems/github into it. Like rdoc.info et al
Post reply on HN