Quest: Documentation Site about ember-animated

[ef4]

Oh, I should have mentioned sooner on this thread, but in the last week or so we got them deployed: https://ember-animation.github.io/ember-animated/

[knownasilya]

Would be nice to have the docs live and the url documented here to see the progress and for those that can make small tweaks but not necessarily tackle documenting a whole API section.

[Oreoz]

@ef4 I have a documentation site (using ember-cli-addon-docs) skeleton working on my fork. Only caveat is I currently have a single test failure, I might require assistance to get it passing. My hunch is that it's failing because of the new style changes that ember-cli-addon-docs caused in the dummy application.

Do you want me to PR right away -- or should I get this test passing first (I'm currently stuck on it)?

[ef4]

Happy to review the PR even with a failing test.

[jamesarosen]

@Oreoz if you get a skeleton set up, I'll gladly add one or two early examples.

[Oreoz]

@jamesarosen The documentation skeleton that's scaffolded with Addon Docs should now be available on master.

As a side note, I'm currently taking a stab at JSDoc'ing the Sprite class. I'll put up a WIP PR tonight with what I have so far.

[Oreoz]

@ef4 The guys over at ember-cli-addon-docs were open to the idea of sorting private, public and deprecated APIs when I connected with them over Slack. But they're currently re-designing the docs website and advised me to hold off for now.

So I filed an issue in order to get this done in the future.

Reference: ember-learn/ember-cli-addon-docs#121

[ddoria921]

Is there a version of the docs that is live somewhere? Like @knownasilya said, it would be nice to see and contribute to incremental progress that is visible.

[danDanV1]

@ddoria921 @knownasilya I've located the docs in progress. They are being created via using the ember-cli-addon-docs addon.

Serve the dummy app in tests and you can view what documentation has been created as commits are made.
http://localhost:4200/docs/api/components/animated-if

[ef4]

I'm closing this because we do have docs now, and we should open individual issues for places where there are still gaps.