Is there an open-source alternative to ReadMe for Rails?

Yes — Rswag. It mounts into an application you already run, so there is no second deployment and no second database.

How do I replace ReadMe in a Rails app?

Add rswag to your Gemfile, mount it in config/routes.rb at /api-docs, and run its migrations. The whole integration is two lines and a migration.

How much does replacing ReadMe save?

ReadMe is priced from $99/mo. The engines here are open source, so the cost becomes the time to mount one and the resources it uses inside your existing application.

Replace ReadMe

Polished developer docs with an API explorer, on a subdomain of theirs.

ReadMe website From $99/mo Developer experience

Why teams move off ReadMe

From $99 a month for developer documentation on a subdomain of theirs, with your API explorer inside it.

What you give up

The guides, changelog and support surface wrapped around the reference.

This directory says so when an engine only covers part of the job. A replacement that needs a caveat is still worth knowing about — it just should not surprise you in week three.

Drop-in replacement

ReadMe → rswag

# Gemfile
gem "rswag"

# config/routes.rb
mount Rswag::Api::Engine, at: "/api-docs"

Read about Rswag →

1 Rails engine that replaces ReadMe

Rswag
Covers the core of Developer experience

An API explorer on your own domain. Not the guides, changelog and support surface around it.

ReadMe → rswag

No ratings yet →

Questions

Is there an open-source alternative to ReadMe for Rails?: Yes — Rswag. It mounts into an application you already run, so there is no second deployment and no second database.
What do I give up by replacing ReadMe?: The guides, changelog and support surface wrapped around the reference.
How do I replace ReadMe in a Rails app?: Add rswag to your Gemfile, mount it in config/routes.rb at /api-docs, and run its migrations. The whole integration is two lines and a migration.
How much does replacing ReadMe save?: ReadMe is priced from $99/mo. The engines here are open source, so the cost becomes the time to mount one and the resources it uses inside your existing application.

Same category

While you are cancelling things

Chromatic 1 engine →

Codecov 1 engine →

Storybook 1 engine →

SwaggerHub 1 engine →