feat(docs): Add some basic API documents. #12
Conversation
| ## Prerequisites | ||
| 1) An OAuth client id is needed. Go get one from the folks in the #fxa IRC channel on irc.mozilla.org. | ||
| 2) Download/copy/install a copy of the fxa-relier-client in a location accessible by your site. | ||
| 3) In your HTML, include a script tag pointing to fxa-relier-client.js |
pdehaan
Dec 18, 2014
Contributor
Can you change these to "1. ", "2. ", "3. " (instead of parens) so Markdown converts to an
?
Can you change these to "1. ", "2. ", "3. " (instead of parens) so Markdown converts to an
- ?
|
|
||
| ## Prerequisites | ||
| 1) An OAuth client id is needed. Go get one from the folks in the #fxa IRC channel on irc.mozilla.org. | ||
| 2) Download/copy/install a copy of the fxa-relier-client in a location accessible by your site. |
pdehaan
Dec 18, 2014
Contributor
How do I download this? Git clone? npm? bower?
How do I download this? Git clone? npm? bower?
| }); | ||
| ``` | ||
|
|
||
| The promise will not resolve if the user is redirected to Firefox Accounts. The promise will be redirected if a required parameter is missing. |
pdehaan
Dec 18, 2014
Contributor
"The promise will be redirected if a required parameter is missing."
? Should that say "The promise will be resolved if a ..."? (same comment re: line 38 below)
"The promise will be redirected if a required parameter is missing."
? Should that say "The promise will be resolved if a ..."? (same comment re: line 38 below)
|
|
||
| | TASK | DESCRIPTION | | ||
| |------|-------------| | ||
| | `grunt build` | build production resources. See [task source](grunttasks/build.js) for more documentation | |
pdehaan
Dec 18, 2014
Contributor
This link 404ed for me, but I'm never sure if things need to be merged before they resolve correctly. GitHub is tricky w/ links sometimes.
Also, not sure if you want to remove grunt prefix from each of the task names to prevent line breaks. Or not, whatever.
This link 404ed for me, but I'm never sure if things need to be merged before they resolve correctly. GitHub is tricky w/ links sometimes.
Also, not sure if you want to remove grunt prefix from each of the task names to prevent line breaks. Or not, whatever.
| | `grunt build` | build production resources. See [task source](grunttasks/build.js) for more documentation | | ||
| | `grunt clean` | remove any built production resources. | | ||
| | `grunt dev` | watch for changes to source files, run unit tests on changes. | | ||
| | `grunt doc` | generate API docs from YUIdoc tags embedded in source. | |
| | `grunt doc` | generate API docs from YUIdoc tags embedded in source. | | ||
| | `grunt lint` | run JSHint, JSONLint, and JSCS (code style checker) on client side and testing JavaScript. | | ||
| | `grunt test` | run local Intern tests. | | ||
| | `grunt release` | create a new release. creates a `release` branch with current code, creates a new tag, updates the CHANGELOG.md, pushes updates to GitHub. | |
pdehaan
Dec 18, 2014
Contributor
Unrelated, but it may be nice if the release task also updates the CONTRIBUTORS or AUTHORS file (for example: see npm run contributors which calls our custom script in package.json).
Unrelated, but it may be nice if the release task also updates the CONTRIBUTORS or AUTHORS file (for example: see npm run contributors which calls our custom script in package.json).
* `redirected`->`rejected` in API.md when talking about promises and missing parameters. * Add more links to external resources in README.md * Add an installation section to README.md
|
fixes #11 |
|
@pdehaan - updated, thanks for the critical eye! |
| }); | ||
| ``` | ||
|
|
||
| The promise will not resolve if the user is redirected to Firefox Accounts. The promise will be rejected if a required parameter is missing. |
nchapman
Dec 19, 2014
The promise will not resolve if the user is redirected to Firefox Accounts.
It might be helpful to explain that this is expected behavior in the redirect flow rather than something amiss.
The promise will not resolve if the user is redirected to Firefox Accounts.
It might be helpful to explain that this is expected behavior in the redirect flow rather than something amiss.
…rect flow is successful.
|
@nchapman - updated! |
feat(docs): Add some basic API documents.
@zaach, @6a68, @nchapman - could I get a review of these? I'm adding @6a68 and @nchapman because they need some docs NOW.