[QUEST] documentation 2020: or tell a good story

[ghost]

The ember-data core team and contributors would like to modernize the API documentation by EmberConf 2020. Modernizing entails writing a package overview, revising inline documentation and auditing code snippets for accuracy. I broke the sections of this quest issue out by logical aspects of ember-data's API. Each section will list individual tasks.

History repeats; everyone can help!

If you would like to climb the mountain with us claim a logical section of the API by commenting below. That section is yours, documentation-wise, for 48 hours. Let us know if you need more time, need clarity or run into problems trying to work through the task.

For questions, ideas, and other things do post in #dev-ember-data channel on Discord. Doing so enables us to triage effectively and incorporate those changes in a unified fashion to this QUEST issue. Defining a sensible contribution workflow is part of this quest as well. So we'd love to hear any rough edges and ideas for improvement. Fail forward, or so they say.

To preview your work locally follow the steps outlined in ember-jsonapi-docs.

Thank you for contributing!

transform

• an overview introduction according to a common format. See the example format in the minimum serializer interface.
• every public method and class is documented
• provide examples of how to use each thing provided by the package
  1. Transform
  2. BooleanTransform
  3. DateTransform
  4. NumberTransform
  5. StringTransform
• Update code snippet style
  1. native classes
  2. avoid var, prefer let
• smoke test in a real ember application

[Gaurav0]

@efx We should link to the instructions on getting documentation running locally.

[Supot39]

ต้องการเพียงแค่ทำเป็นเงินสกุลยาทไทยที่ใช้ได้ครับ..ต้องทำเช่นไร..แนะนำด้วยครับ..ผมไม่เก่งภาษาและระบบคอม...ค่าใช้จ่ายการเท่าไหร่หักไปเลยครับ...

[Angel-gc]

I'd like to grab the overview introduction (first bullet point)

[runspired]

@Angel-gc that would be great! I just worked on some infra for the api docs app that will make this even nicer, happy to pair with you to get your setup running well locally to work on this.