API docs?

[graue]

I've scanned the readme for this project several times, and maybe I'm missing it, but I don't see a link to the API docs. Do they exist? Where?

[MajorBreakfast]

RSVP hasn't it's own site, yet. You could either:

• Use Ember's doc site

  http://emberjs.com/api/classes/Ember.RSVP.html http://emberjs.com/api/classes/Ember.RSVP.Promise.html

• Use the spec

  https://github.com/domenic/promises-unwrapping

• Or read the code comments

[stefanpenner]

We should likely create a quick API site/page at some point

[mikepmunroe]

Where would the new site/page live? I'm guessing an initial version would start with just the API docs from code. The same docs used for Ember Data at the Emberjs.com site?

[stefanpenner]

likely just a github page. Ya we have YUIdoc so it wouldn't be hard to generate and drop them somewhere else.

[adamesque]

FYI, looks like the docs have been removed from Ember API site. Not sure if intentional?

[stefanpenner]

@adamesque accidental, I believe WIP exists to restore.

I am also going to work towards an RSVP.js website.

[jpotterm]

We could use the Wiki on this repository.

[stefanpenner]

@jpotterm the source contains very detailed docs. I don't think also adding a wiki is a good idea. I hope to give rsvp its own site in the next month or so. Then the docs will be more up and center

[billybonks]

updated url for ember docs

http://emberjs.com/api/classes/RSVP.html

a little incomplete though

[robksawyer]

+1 for just adding some examples, use cases and brief documentation to the Github wiki. Why not?

[tchan]

Sorry for bumping this but I didn't want to create a new issue. The definitions on the url seem to be broken (for everything relating to RSVP). Eg: https://www.emberjs.com/api/classes/RSVP.Promise.html Any ideas on how to fix this?

[stefanpenner]

@travismchan likely an issue with the ember website