Add technical documentation/user-guide for the API

thinkingmachines / linksight-2018

LinkSight is a web app for applying the Philippine Standard Geographic Code to messy and misspelled barangay, municipality, city, and province names.

https://linksight.thinkingmachin.es

GNU General Public License v3.0

11 stars 1 forks source link

Add technical documentation/user-guide for the API #283

Closed ljvmiranda921 closed 5 years ago

ljvmiranda921 commented 6 years ago

Interested on creating a technical documentation/user-guide for our API like this? So that we won't dump everything in README and just point potential contributors to our documentation.

I can help set one up in ReadTheDocs using Sphinx.

Possible changes

Just add more docstrings
docs/ directory to house .RST files

piafaustino commented 5 years ago

@ljvmiranda921 @marksteve How would this issue be distinct from #297, which refers to documenting the API client?

piafaustino commented 5 years ago

Duplicate of #297