Ruby has few sites to search for how to use certain APIs.
Current Ruby API docs
The official site looks ok. Style is a little bit out of date and a bit hard to search. That’s probably why Ruby-Doc.org has the most traffics for Ruby API documentations, but it has Ads. I understand that someone give something for free for the public, and try to cover the costs. But I go there less and less often because of the Ads are a distraction when I need to find something. Then I turn into tools like pry-doc to search documents on the fly.
But there is good news recently!
Introducing ruby api
- Beautifully done. Free with no ads.
- Readable on any size device (mobile)
- Fast on any speed internet connection (performance dashboard)
- Intuitive search results (
- Link to CRuby source code (click the GitHub icon)
- Runnable example
Besides these awesome features, it is also good for you if you’re looking for something to learn, to contribute to a well-crafted Rails codebase written with lots of cool ruby idioms. It’s Open Source.
The tech stack of the ruby api:
- Rails 6, Falcon, webpack, Tailwind CSS, Slim, Stimulus
- GraphQL, Elasticsearch, GitHub Actions, Standard
- Well-tested with Minitest
Give it a try. Spread the word. Enjoy!