RailsAPI.com - Rails API docs with smart search
Downloadable Rails API package with smart search as you type, clean interface, github links, class browsing and a gem to build your own docs. Formely http://voloko.ru/sdoc/rails/
sudo gem install voloko-sdoc --source <http://gems.github.com>
sdoc --github_url <http://github.com/yourname/yourproject> -S projectdir
Comments
Love it! Thanks.
I’m sorry, but why on Earth do we need another api search engine/site? How about if everyone concentrated on improving ONE site instead of redoing the same thing over and over?
It was probably a rhetorical question, Drew, but it’s easy(ish) to build a new documentation presentation system and it seems lots of people have different ideas about how it should be done ;-)
Curiously, I have not noticed any of the various efforts to really “catch on” in any sense that one option dominates the others, so I guess users have different ideas on how it should be done too.
2 Drew: The same reason we’ve got so many editors/IDEs out there. “Better” is different for different people. None of existing projects felt right for me. Especially on a mac.
2 PeterCooper: Yep. It’s quite easy to build a prototype. But it’s the details which make a difference for me. Doc preview/method params in search results which required rewrite of rdoc internals. 3-phase search over 3k-elements index which still fills snappy on 5-year-old machines. Github links which require commit sha1. Etc. So it took some time. Some pieces are still missing. I hope to fix them this weekend.
Nevertheless it’s a two-evenings project. So don’t be too hard on it :) and thank you for your feedback.
BTW, you definitely have the best site “selling” your solution. I love the way you’ve used screenshots so heavily. A lot of people forget that pictures sell!
I guess my issue is that they all feel exactly the same to me and are all missing something. No one is terribly good. They all have one or two nice features (appearance, searchability, commenting, socialization, etc), but lack the others. If there were one definitive one that the community could center around, then maybe we could have all those features in one place.
http://rails.uservoice.com/pages/rails3/suggestions/98450-try-to-merge-all-the-rails-doc-apps
Yet, only recommending for the symbol associated with Fendi Purses and replica watch do not match your person. Looking forward to below wholesale Fendi wholesale bags usually means no longer daydreaming around delivering your personally own collecting Fendi designer watches uk.One are only able to picture the escalating nausea of buyers the moment programs involving low cost Burberry affordable Breitling replica watches not to mention general Fendi purses and bags show up.
Have you ever thought about adding a little bit more than just your articles? I mean, what you say is valuable and all.write my proposal
Post a comment