Generate documentation site

[alexlafroscia]

It would be great to generate a documentation site, maybe something using ember-cli-addon-docs! If we can publish it to the gh-pages branch here, then it'll be hosted at ember-cli.com/ember-ajax automatically, which would be pretty cool.

Some things to cover:

• Usage
  • as a service
  • as an object
  • with the functions provided
• TypeScript
  • Asserting response type by providing a type annotation
• Error detection using the provided helpers
• Common customization behavior
  • Creating richer Error classes (see resolution to Customizable Error Classes #292)

Other tasks

• Simplify README (move some of the complex examples to the docs site)

[sandstrom]

I thought the aim was to move away from this addon, onto ember-fetch? If that's the case, wouldn't it make more sense to focus efforts elsewhere?

But perhaps I'm just mistaken about that 😄

[alexlafroscia]

With ember-cli-addon-docs it's pretty easy to create documentation, and I've never been happy with what this addon has. You're right, though, so maybe this will just stay open for a while.

I'm probably not going to do this myself, but if someone is new to OSS and wanted something that was pretty easy, I would be happy to work with them on re-vamping the documentation story here!

[sandstrom]

@alexlafroscia Somewhat related: how about a note on top of the readme, mentioning that ember-fetch also exist and is an equally good option. That way, beginners will at least be aware of that option. What do you think about that?

[alexlafroscia]

Yes, that's a great idea.

I'd also like to lobby (maybe through an RFC) that ember-ajax is removed as the default install on new projects and that ember-fetch, if anything, is installed instead.