mozilla / chronicle

find everything you've ever found
http://mozillachronicle.tumblr.com/
Mozilla Public License 2.0
16 stars 6 forks source link

feat(docs): add a /docs route using Lout #355

Closed pdehaan closed 9 years ago

pdehaan commented 9 years ago

Adds a http://localhost:8080/docs route which shows some auto-generated route documentation using Lout.

It ain't pretty, but meh.

Closes #108

pdehaan commented 9 years ago

r? @nchapman so he can look at how stupid this stupid is, and say "this is stupid, i don't want this" and close this. Or merge it, whatever. Not like I'm paid per pull-request.

But yeah, I'm sure we could use some better descriptions, but figure we'll do baby steps and see if it's worth proceeding further before I try and copy/pasta /docs/API.md into various descriptions.

pdehaan commented 9 years ago

documentation_for_rest_routes

jaredhirsch commented 9 years ago

@pdehaan I'm game to try this, let's land it. I'm going to do a cleanup pass at the API this sprint (#222), seems like a good opportunity to give this a shot.

jaredhirsch commented 9 years ago

Ah, looks like you'll need to rebase before landing. (If you want, you can start pushing branches to mozilla instead of your fork, then I can rebase-and-merge stuff like this for you.)

pdehaan commented 9 years ago

Rebased. Travis green. Self merge.