README.md

Overview

This repo contains:

• Documentation for Soundtrack API
• Auto-generated reference for Soundtrack API
• Documentation for Soundtrack SDK

Feedback/suggestions

• For Soundtrack API: make pull requests of this file
• For Soundtrack SDK: make pull requests of this file

Questions

Join our public Slack channel.

Kudos

Thanks to Slate & GraphDoc.

Making updates

Soundtrack employees only

1. Review pull request. Pull requests are only allowed on these two files: API & SDK.
2. Head to docs/api/generate/ to generate docs
   • Install prerequisites: node, ruby (>2.3.1) & bundler.
   • Install dependencies bundle install
   • Install graphdoc yarn global add @2fd/graphdoc
   • Generate docs ./generate.sh
3. Commit and push back into repo. The pages will be updated automagically.