search

TheMinusWorld / Mayhem-Whereabouts

Master repository for the Mayhem Whereabouts software
GNU Affero General Public License v3.0
0 stars 1 forks source link

API Documentation #11

Open wtl420 opened 4 years ago

wtl420 commented 4 years ago

Going to read through this guide and hopefully conform to these standards: https://apiguide.readthedocs.io/en/latest/

APIs should be documented on this repo's wiki, https://github.com/TheMinusWorld/Mayhem-Whereabouts/wiki

wtl420 commented 4 years ago

The main goal of this is creating a boilerplate to make it easy to add to the documentation.

I think we can reasonably start with the account API - accounts should be pretty basic as most user data will be on characters instead.

wtl420 commented 4 years ago

Relates to #4

arati-1 commented 4 years ago

Hi,

I am a technical writer, with experience in documenting REST API. Do you need API's documented? If you can provide some guidance about your project, may be I will be able to contribute.

Thanks, RT

keithpickering commented 4 years ago

@arati-1 We have no API yet but we need all the help we can get

arati-1 commented 4 years ago

@keithpickering thanks. Do let me know when you have API, and also if you have any other documentation needs.

keithpickering commented 4 years ago

@wtl420 How should we get this started?

Brennakm commented 4 years ago

Hey, I can document REST APIs. Let me know if you need help.