Skip to content
This repository has been archived by the owner on Aug 21, 2018. It is now read-only.

Commit

Permalink
Add some goals, so I'm not floundering so much
Browse files Browse the repository at this point in the history
  • Loading branch information
paul committed Aug 1, 2012
1 parent 726c26a commit 71d5939
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.mkd
@@ -0,0 +1,23 @@

## Goals

### Main docs in a single page

[Parse API](https://www.parse.com/docs/rest)
[Blog Post explaining why on Parse API](http://blog.parse.com/2012/01/11/designing-great-api-docs/)

Separate pages ok for long-form parts, like detailed multi-step tutorials, OAuth, etc...

### Inline code examples for each language/library we "support"

[Stripe's API Docs](https://stripe.com/docs/api) has a switcher at top to pick your preferred language.

### Use the user's token in examples

If the visitor is logged in to github.com, automatically use their username/token in the examples. We'll probably have
to punt on several of the examples, though. Eg, `/user` would show the current user, but we don't want to have to remake
the request for each example * language on the page. This would lead nicely into a future javascript API explorer, though.




0 comments on commit 71d5939

Please sign in to comment.