search

etcgroup / text-prizm

3 stars 0 forks source link

API documentation skeleton #44

Closed michaelbrooks closed 11 years ago

michaelbrooks commented 11 years ago

I'm trying to figure out a good way to document our API. @katiek and @geosoco , what do you both think of this setup?

I created a wiki page about all of the different APIs here: API Documentation

That page links to docs/rest.md, which is a file written in Markdown syntax that will be checked into our repository.

rest.md links to several other md files about different parts of the rest api, such as docs/rest/data.md.

docs/rest/data.md documents the REST API controller that is currently at src/server/controllers/api/data.php. That will all move around soon but that is where it is right now.

If you want to see these documentation pages in action you can view docs/rest.md in GitHub's viewer.

Open to other suggestions!

michaelbrooks commented 11 years ago

FYI this is inspired by https://github.com/marionettejs/backbone.marionette/tree/master/docs

ksen0 commented 11 years ago

Consistent with what we discussed. Go ahead and merge.