Ramen API Docs

We're using Slate to generate beautiful API docs.

Development

To get started,

git clone git@github.com:ramen-dev/ramen-api-docs.git
cd ramen-api-docs
bundle install

You can run a local version of the docs site via the middleman server by running,

middleman server

And going to 0.0.0.0:4567

Deployment

We're using Github pages to host the API docs.

Therefore to publish the docs you run,

rake publish

And changes will be published/deployed to docs.ramen.is