5 ms·

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? Ex

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?

csmattryder 13y ago
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 flourish, it seems a lot faster than searching ruby-doc! Keep at it, guys! :)
- timr 13y ago
  Thanks! Is this more like what you're looking for? http://www.omniref.com/docs/ruby/stdlib/2.0.0-p247/classes/Array.html 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.
  - csmattryder 13y ago
    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.
    - timr 13y ago
      We're working on that right now, actually. We weren't sure that people would want it, though, so that's good feedback. ;-)
      - ollysb 13y ago
        That looks perfect, would definitely be appreciated.
derwiki 13y ago
Enumerate options that are obscured by inheritance. For example, to look at: http://www.omniref.com/?q=cache_action 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.
- timr 13y ago
  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?
atmosx 13y ago
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.
- timr 13y ago
  This is on the feature short-list. We actually had it in there early on, but we weren't happy with the quality, so we pulled it. We're going to re-try with a different approach that we think will work better. It's definitely going to happen.
JonnieCache 13y ago
Load the rdoc for all of rubygems/github into it. Like rdoc.info et al
- timr 13y ago
  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.
  - JonnieCache 13y ago
    Ah. It seems that for some reason I searched by the gem name, which obviously came up with nothing.
    - timr 13y ago
      Hm. You searched for rails, or something else? http://www.omniref.com/?q=rails http://www.omniref.com/?q=rails Let us know if there's a bug.
      - JonnieCache 13y ago
        http://www.omniref.com/?q=fuzzy_match http://www.omniref.com/?q=fuzzy_match doesnt take me to http://rubygems.org/gems/fuzzy_match http://rubygems.org/gems/fuzzy_match
william_hc 13y ago
comments for sure. Could be as simple as disqus on endpoints like the angular docs.
jaredgrippe 13y ago
It would be awesome if I could upload (or just post) my Gemfile to your site and be able to search only the gems I am using.
- timr 13y ago
  I've wanted this since the beginning, so this is coming soon. ;-)
  - jaredgrippe 13y ago
    awesome! I cannot wait! :D sign me up for any beta action you got :P
    - timr 13y ago
      Heh. We skimped a bit on the "beta" invite thing. Send me an email (addr is on my profile) and I'll let you know when it's ready.
jaredgrippe 13y ago
It would also be nice to use chrome's "tab to search" feature so I can just type: "omniref" [TAB] [query]
- jc00ke 13y ago
  This!

csmattryder 13y ago

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 flourish, it seems a lot faster than searching ruby-doc! Keep at it, guys! :)

timr 13y ago
Thanks! Is this more like what you're looking for? http://www.omniref.com/docs/ruby/stdlib/2.0.0-p247/classes/Array.html 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.
- csmattryder 13y ago
  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.
  - timr 13y ago
    We're working on that right now, actually. We weren't sure that people would want it, though, so that's good feedback. ;-)
    - ollysb 13y ago
      That looks perfect, would definitely be appreciated.

derwiki 13y ago

Enumerate options that are obscured by inheritance. For example, to look at: http://www.omniref.com/?q=cache_action 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.

timr 13y ago
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?

atmosx 13y ago

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.

timr 13y ago
This is on the feature short-list. We actually had it in there early on, but we weren't happy with the quality, so we pulled it. We're going to re-try with a different approach that we think will work better. It's definitely going to happen.

JonnieCache 13y ago

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

timr 13y ago
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.
- JonnieCache 13y ago
  Ah. It seems that for some reason I searched by the gem name, which obviously came up with nothing.
  - timr 13y ago
    Hm. You searched for rails, or something else? http://www.omniref.com/?q=rails http://www.omniref.com/?q=rails Let us know if there's a bug.
    - JonnieCache 13y ago
      http://www.omniref.com/?q=fuzzy_match http://www.omniref.com/?q=fuzzy_match doesnt take me to http://rubygems.org/gems/fuzzy_match http://rubygems.org/gems/fuzzy_match

william_hc 13y ago

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

jaredgrippe 13y ago

It would be awesome if I could upload (or just post) my Gemfile to your site and be able to search only the gems I am using.

timr 13y ago
I've wanted this since the beginning, so this is coming soon. ;-)
- jaredgrippe 13y ago
  awesome! I cannot wait! :D sign me up for any beta action you got :P
  - timr 13y ago
    Heh. We skimped a bit on the "beta" invite thing. Send me an email (addr is on my profile) and I'll let you know when it's ready.

jaredgrippe 13y ago

It would also be nice to use chrome's "tab to search" feature so I can just type: "omniref" [TAB] [query]

jc00ke 13y ago
This!