The internals of the API should be documented somewhere: what the method calls take, what the return, where to find them, etc.
Right now the website is the only consumer of the API, but that may not always be the case. If someone, say, wanted to create an app that was compatible with the site, it would be very handy to have this kind of reference.
IMO, this could be written in markdown in some top-level docs folder in the repo, but I'm open to suggestions.
BrandonLMorris
commented
8 years ago
The internals of the API should be documented somewhere: what the method calls take, what the return, where to find them, etc.
Right now the website is the only consumer of the API, but that may not always be the case. If someone, say, wanted to create an app that was compatible with the site, it would be very handy to have this kind of reference.
IMO, this could be written in markdown in some top-level docs folder in the repo, but I'm open to suggestions.