Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation for RecordData #6359

Closed
runspired opened this issue Aug 21, 2019 · 5 comments
Closed

Add Documentation for RecordData #6359

runspired opened this issue Aug 21, 2019 · 5 comments
Labels
🏷️ doc This PR adds/improves/or fixes documentation 🌲 Project Trim 🌲 PRs related to https://github.com/emberjs/data/issues/6166

Comments

@runspired
Copy link
Contributor

We currently do not have documentation for this public feature.

@ChaiWithJai
Copy link

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

@runspired
Copy link
Contributor Author

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.

@ChaiWithJai
Copy link

@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.

@runspired
Copy link
Contributor Author

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
Copy link
Contributor Author

I added documentation when I implemented V2, improved documentation will be added when we ship the new Cache emberjs/rfcs#854

@runspired runspired added 🏷️ doc This PR adds/improves/or fixes documentation and removed Documentation labels Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ doc This PR adds/improves/or fixes documentation 🌲 Project Trim 🌲 PRs related to https://github.com/emberjs/data/issues/6166
Projects
Archived in project
Development

No branches or pull requests

2 participants