Live data from Hacker News

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

omniref.com

21–30 of 63 posts

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

#22
post #10

Earlier quoted context omitted.

Some feedback I have, is that I would like the sidebar to have a view that was less 'cluttered'. I know what String#new does, so could I just view all the methods available - sans description? Like how ruby-doc does it, super fast to spot what I need to lookup and click it. Another is that the sidebar seems to take up a fair bit of space (especially as I use a half-sized browser window). I really want to see this flo…

Thanks! Is this more like what you're looking for? http://www.omniref.com/docs/ruby/stdlib/2.0.0-p247/classes/A... We're still working out how to display the search results, but we definitely want to strip them down more. Thanks for the feedback.

Yep, that's it. Would love to just click the one from the results, then have that view. But if I have to then click the name on the right, that's fine too.

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

#24

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?

comments for sure. Could be as simple as disqus on endpoints like the angular docs.

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

#25
post #21

Very nice. One note though. When I look for "puts", I get OpenSSL::Buffering#puts when I'd expect Kernel#puts. "kind_of" gives me RSpec::Mocks::ArgumentMatchers#kind_of. I think you should assign proper weights.

We've done a lot of work to weight things correctly (e.g. searching for "inject" does what you'd expect), but we definitely need to do more work on really common tokens like "puts".

We'll add those to our bad search list. Thanks for the feedback!

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

#26
post #10

Earlier quoted context omitted.

Thanks! Is this more like what you're looking for? http://www.omniref.com/docs/ruby/stdlib/2.0.0-p247/classes/A... We're still working out how to display the search results, but we definitely want to strip them down more. Thanks for the feedback.

Yep, that's it. Would love to just click the one from the results, then have that view. But if I have to then click the name on the right, that's fine too.

We're working on that right now, actually. We weren't sure that people would want it, though, so that's good feedback. ;-)

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

#28

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

We already have all of the documentation for all of the current ruby gems, plus the ruby standard library. We don't yet have all versions of everything, but that's coming soon.

AFAIK, we're already more comprehensive than the existing sites, though.

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

#29
post #21

Very nice. One note though. When I look for "puts", I get OpenSSL::Buffering#puts when I'd expect Kernel#puts. "kind_of" gives me RSpec::Mocks::ArgumentMatchers#kind_of. I think you should assign proper weights.

We're looking at several other signals than tf/idf right now, but the really big improvements in quality will come from static & runtime analysis of all the publicly available ruby code for just this sort of case. I'll make sure these get added to our ever growing list of QA queries so we can make sure they improve.
Post reply on HN