data icon indicating copy to clipboard operation
data copied to clipboard

Add Documentation for RecordData

Open runspired opened this issue 6 years ago • 4 comments

We currently do not have documentation for this public feature.

runspired avatar Aug 21 '19 21:08 runspired

I think I can tackle this. We're looking to add information to this page?

ChaiWithJai avatar Feb 28 '22 18:02 ChaiWithJai

We want to add an overview of the feature and how to use it here: https://api.emberjs.com/ember-data/release/modules/@ember-data%2Frecord-data

We would then add the RecordData interface (clearly marking it as v1, there is an unimplemented v2 that will arrive soon-ish) as well as document the DefaultRecordData.

runspired avatar Mar 01 '22 10:03 runspired

@runspired is my idea is to follow this API guide as a template.

And for my research, I'll read the Record Data RFC and grok the code.

ChaiWithJai avatar Jun 16 '22 19:06 ChaiWithJai

I wrote docs for the store APIs associated with custom records and record-data implementations in #8114. RecordData itself still needs documented, I'm planning on adding documentation for it as I implement V2.

runspired avatar Aug 11 '22 17:08 runspired

I added documentation when I implemented V2, improved documentation will be added when we ship the new Cache https://github.com/emberjs/rfcs/pull/854

runspired avatar Nov 17 '22 03:11 runspired