BeaconServers / Beacon-Backend

1 stars 0 forks source link

Better API Documentation #19

Open billyb2 opened 3 years ago

billyb2 commented 3 years ago

This will likely be an ongoing git issue, since as the Beacon Backend grows, it will have more api's to deal with. Gonna be using the fancy new milestone feature for this. I'll be assigning this to everyone, since it's a relatively easy thing to do by reading the backend code, I'd recommend looking up how to send POST requests in React JS.

The documentation should be very general purpose, meaning it can be applied to any language, with a focus on JS examples. The documentation should also be in the docs folder (not yet created) at the root of the git repo, with each piece of documentation being in markdown. As the documentation grows, it should be split into subfolders within the docs folder, in order to allow more organization.

billyb2 commented 3 years ago

Whoops, apparently I can only assign one person at a time :/