Kitsu is a modern anime discovery platform that helps you track the anime you're watching, discover new anime and socialize with other fans.
This is our api docs repository.
Check out the meta, client and server repositories.
The documentation is written with API Blueprint and MSON. Trivial changes can be added using GitHub's built-in editor. For bigger changes it is advised to follow the steps below.
If you have any questions you can:
- Join our Discord server
- Join our Slack by sending an email to josh@kitsu.io
- Ping @wopian, @matthewdias or @nuck on Kitsu.
-
Clone the repo (
git clone https://github.com/{yourusername}/api-docs.git) -
Create a new branch (
git checkout -b improve-docs) -
Install dependencies (
yarn) -
Make the appropriate changes in the source files
-
Check your changes for issues (
yarn test) -
Commit your changes (
git commit -am 'feat: improve docs') -
Push to your branch (
git push origin improve-docs)