Welcome to the repository for Algorithmia's API. Here you will find the API reference, as well as some documentation on getting started with the API and basic set up.
These docs are built on Slate. Learn more over at the official repo.
You're going to need:
- Linux or OS X — Windows may work, but is unsupported.
- Ruby, version 1.9.3 or newer
- Bundler — If Ruby is already installed, but the
bundlecommand doesn't work, just rungem install bundlerin a terminal.
- Fork this repository on Github.
- Clone your forked repository with
git clone https://github.com/YOURUSERNAME/api-docs.git cd api-docs- Install all dependencies:
bundle install. If you are having trouble with some of the gems, try runningbundle update, then runbundle installagain. - Start the test server:
bundle exec middleman server
You can now see the docs at http://localhost:4567. Whoa! That was fast!
If you are making any changes to the stylesheets or javascript, run rake build to re-build the project so you can see your changes.
First, check out a new branch and make any changes on that branch. When you are ready, make a pull request to this repo and we will review the changes. Be sure to describe the changes, attach screenshots of any cosmetic changes, and if applicable, link to the open issue.
If you find a bug, can't follow the documentation or have a question – submit an issue!
We will respond to you or reach out for more information as soon as possible. And, of course, feel free to submit pull requests with bug fixes or changes.