search

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

Update README with more details about the project and its setup. #85

Closed alexeykostevich closed 4 years ago

alexeykostevich commented 4 years ago
alexeykostevich commented 4 years ago

This PR is the result of my research of the environment setup, which we discussed on the last Ember Learn meeting.

Overall, I found just a few mismatches between the docs and the actual API (e.g. the lack of --sync flag in npm start). After a bit of troubleshooting, I've finally generated docs from both AWS and local repositories and served them in the ember-api-docs app.

Screen Shot 2020-04-21 at 2 48 06 am

Being I'm a newcomer, it was a bit hard for me to jump in straightaway without looking into the code. Therefore, I've tried to digest the docs and provide more information for new contributors. The PR also updates the docs according to the latest tool's API. Here is how it looks like now: https://github.com/alexeykostevich/ember-jsonapi-docs/blob/doc/readme-update/README.md

@mansona , @jenweber, @MelSumner , please, let me know if you have any concerns about the structure and format of the docs.

Also, I would like to ask you to carefully review the Overriding a specific version of YUIDoc file with a local copy (for core contributors). section, since I was not able to actually test it. However, I'm 90% confident that it is correct.

jenweber commented 4 years ago

Hi @Gaurav0, if you have time, could you have a read through this? Thanks!