ember-learn / ember-jsonapi-docs

fixes up the ember docs generated by YUIDoc to be in JSONAPI format + some other niceties
9 stars 11 forks source link

rearrange and polish some of the README.md content #71

Closed ghost closed 4 years ago

ghost commented 4 years ago

As a developer working on documentation locally, I am interested in just this task. (e.g. I have no kingdom keys). Reading through the README.md and following the steps was a bit confusing at first. I can submit PRs based on any consensus for the points below.

ember-jsonapi-docs is for turning code comments in ember.js into json api compliant data for use in various applications seeking to use the Ember API.

Is there a difference between running "this app" versus serving up the local transformed yuidocs with yarn server? Either way it seems we could remove the first part of line 5 but additional clarity in these steps would reduce confusion.

sivakumar-kailasam commented 4 years ago

Thanks for the feedback @efx, will gladly accept a PR with all of these changes.