Omniref
Dev tools
documentation search
SHOW HN2013
How HN took it
13 positive, 15 neutral or asking, 2 mixed, 5 critical, out of 35 comments about the project. Thread score +0.25.
Execution: 1 for, 3 againstIdea: 2 for, 0 againstDesign: 1 for, 1 againstDocs: 1 for, 1 against
The thread, comment by comment
Each row is a top-level comment and its replies, in HN's order. Select a cell to open that comment on HN.
positive neutral or mixed critical about another commenter or something else the maker
What HN said
What people liked
Fast search
From 2 comments
I like the speed of the search and most of the layout. It could really use some kind of Table of Contents for the current entry, though. For more fanciful ideas, it would be neat…
ufmace on HNSome 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 -…
csmattryder on HN
Improved cross references and clean layout
From 2 comments
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.
emmett on HNI like the speed of the search and most of the layout. It could really use some kind of Table of Contents for the current entry, though. For more fanciful ideas, it would be neat…
ufmace on HN
Objections
Search ranking returns irrelevant common-token results like puts
From 1 comment
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…
znowi on HN
Sidebar is cluttered and takes too much space
From 1 comment
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 -…
csmattryder on HN
Some gem names do not resolve to their pages
From 1 comment
http://www.omniref.com/?q=fuzzy_match doesnt take me to http://rubygems.org/gems/fuzzy_match
JonnieCache on HN
Requests
Search only gems listed in a Gemfile
From 1 comment
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.
jaredgrippe on HN
Code examples and comments on documentation
From 2 comments
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.
atmosx on HNcomments for sure. Could be as simple as disqus on endpoints like the angular docs.
william_hc on HN
API or editor integration such as Emacs and Vim
From 2 comments
Do you have an api? It would be nice to be able to make emacs do M-x ruby-apropos foo and pick something.
endgame on HNVim users also want :)
derwiki on HN
Index a local or public repo project
From 1 comment
Is there some way I can view my own ruby project with this? like by pointing it at my github repo url/ssh url?
moonie1 on HN
Questions
Does it support multiple versions of gems
From 1 comment
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…
montanalow on HN
Alternatives named
YARD
From 1 comment
Anyone looking for functionality like this in a local, offline reference should check out YARD[1]. I (embarrassingly) only recently set it up to serve a set of my common gems and…
latortuga on HN
ruby-doc
From 1 comment
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 -…
csmattryder on HN
APIdock
From 1 comment
I also like APIdock. They show the version history of a method - http://apidock.com/rails/v3.0.0/String/camelize
mckaym on HN
DevDocs
From 1 comment
Well done! I've also been trying to improve Ruby's documentation with DevDocs: http://devdocs.io/ruby/
Thibaut on HN
rdoc.info
From 1 comment
Load the rdoc for all of rubygems/github into it. Like rdoc.info et al
JonnieCache on HN