This repository has been archived by the owner on Aug 21, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some goals, so I'm not floundering so much
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
|
||
|
||
|