https://github.com/soundtrackyourbrand/docs

Documentation for Soundtrack API & SDK.
https://github.com/soundtrackyourbrand/docs

Last synced: about 2 months ago
JSON representation

Documentation for Soundtrack API & SDK.

• Host: GitHub
• URL: https://github.com/soundtrackyourbrand/docs
• Owner: soundtrackyourbrand
• Created: 2019-01-15T07:47:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-23T11:27:15.000Z (about 1 year ago)
• Last Synced: 2024-01-24T11:25:39.297Z (about 1 year ago)
• Language: HTML
• Size: 1.66 MB
• Stars: 4
• Watchers: 21
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Overview

[This repo](https://github.com/soundtrackyourbrand/docs) contains:

* [Documentation for Soundtrack API](https://developer.soundtrackyourbrand.com/api)

* [Auto-generated reference for Soundtrack API](https://developer.soundtrackyourbrand.com/api/reference)

* [Documentation for Soundtrack SDK](https://developer.soundtrackyourbrand.com/sdk)

# Feedback/suggestions

* For Soundtrack API: make pull requests of [this file](https://github.com/soundtrackyourbrand/docs/blob/master/api/generate/source/index.html.md)

* For Soundtrack SDK: make pull requests of [this file](https://github.com/soundtrackyourbrand/docs/blob/master/sdk/index.md)

# Questions

[Join our public Slack channel](https://join.slack.com/t/soundtrack-api/shared_invite/enQtNjM5MzAwMzExNTI3LTg0ODY3NzViNzIzNjRmOWZiODc4YjQ4ZTZmYzA2MzRiNWIwMmYyNjRhMDdjNjdlMmYwNzk0NzM3OTdkZWRhZTQ).

# Kudos

Thanks to [Slate](https://github.com/lord/slate) & [GraphDoc](https://github.com/2fd/graphdoc).

# Making updates

**Soundtrack employees only**

1. Review pull request. Pull requests are only allowed on these two files: [API](https://github.com/soundtrackyourbrand/docs/blob/master/api/generate/source/index.html.md) & [SDK](https://github.com/soundtrackyourbrand/docs/blob/master/sdk/index.md).

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.