Team-TAU / tau

TAU- Twitch API Unifier, a containerized relay/proxy to unify the WebHook- and WebSocket-based real-time Twitch APIs under a single (local) WebSocket connection.
MIT License
149 stars 38 forks source link

Document API v1 endpoints #63

Closed wwsean08 closed 3 years ago

wwsean08 commented 3 years ago

Create initial documentation for API endpoints, as well as updates the .gitignore to ignore the .idea directory for us jetbrains users.

Related to #60 Related to #8

Description

Endpoints documented:

Create CI job to build the docs using mkdocs in the read the docs theme in prep for deploying them, see https://github.com/wwsean08/tau/actions/runs/975634598 as an example with the mkdocs artifact that you can open to view the docs live in your browser.

Motivation and Context

Make usage of tau easier for new users by documenting the various API endpoints.

How Has This Been Tested?

N/A

Types of changes

Checklist:

wwsean08 commented 3 years ago

No more changes planned unless there are changes requested.

FiniteSingularity commented 3 years ago

This looks fantastic! Thanks for all your hard work getting these endpoints documented @wwsean08.