Ruby API: Easily Find Ruby documentation

Ruby API makes it easy and fast to search or browse the Ruby language API docs.

Why?

The existing websites for Ruby documentation are hard to search, and impossible to read on mobile devices. Ruby API provides instant search results, inspired by Dash, and a responsive design that's easy to read on any size device.

We aim to improve the Ruby ecosystem by being:

Readable on any size device
Fast on any speed internet connection
Relevant search results that surface useful APIs
Search engine optimized pages for every API method
Free, with no ads. Ever.

Getting started

Github Dev Container

For an quick, easy and automated way to get started, you can use the Github Dev Container.

Github Dev Containers will automatically install all the dependencies and start the application.

Local Machine

Install dependencies:

Note: This command can also be used to quickly update the application dependencies

bin/setup

Start ElasticSearch:

docker compose up -d

Start the Rails Server

bin/dev

Importing Documentation

Ruby's documentation can be imported very easily. There's a rake task that will let you import a given versions' documentation:

bin/rails import:ruby[3.1]

or you can easily import the latest versions of all currently supported versions of ruby:

bin/rails import:ruby:all

Running tests

The test suite can be executed with:

bin/rails test

Linting code

This project uses StandardRB for linting.

StandardRB can be executed with:

bin/standardrb

Note: This command may make changes to your code, to make it conform to the formatting rules of this project.

For instructions on running StandardRB in your editor, check out StandardRB's Documentation.

Code Of Conduct

Everyone interacting with the source code, issue trackers, chat rooms, and mailing lists is expected to follow the Code Of Conduct

License

Ruby API is licensed under the MIT license.

natematykiewicz/rubyapi