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

Docs still missing keyForEmbeddedRelationship for serializers #2064

Open
levimllr opened this issue Oct 8, 2020 · 2 comments
Open

Docs still missing keyForEmbeddedRelationship for serializers #2064

levimllr opened this issue Oct 8, 2020 · 2 comments

Comments

@levimllr
Copy link

levimllr commented Oct 8, 2020

Feature request

According to #1451, the keyForEmbeddedRelationship serializer hook should be described in the docs, but I'm not finding it at https://www.ember-cli-mirage.com/docs/data-layer/serializers or https://www.ember-cli-mirage.com/versions/v0.4.x/serializers/. Just a heads up! Still a useful hook for snake_cased troglodytes like myself 😅

@levimllr
Copy link
Author

levimllr commented Oct 8, 2020

Nevermind! I found keyForEmbeddedRelationship with a deeper search. The link in that issue (http://www.ember-cli-mirage.com/docs/api/modules/ember-cli-mirage/serializer~Serializer#keyForRelationship) was incorrect and I didn't even see the links to the API documentation on the generated docs page (https://www.ember-cli-mirage.com/docs).

I think there's a couple tangential issues here:

  1. The (old? or incomplete) documentation appears higher in search results. Searching for "ember mirage serializer" gives me https://www.ember-cli-mirage.com/versions/v0.4.x/serializers/ as the number one result.
  2. The API docs on the generated doc site are not visible at all without scrolling in the left-hand navigation bar, making them hard to find.

If I can help in any way, let me know. Thank you for writing such a useful library!

@samselikoff
Copy link
Collaborator

Thanks for posting this + sorry you ran into it! The goal is to remove most of the content from ember-cli-mirage.com so Ember users can reference miragejs.com. It's taken longer than expected which is why the ember-cli-mirage site is a bit old.

I think the best bet is to reference miragejs.com for the latest info, with the exception of a few ember-specific things like the auto discovery of models and the ember data serializer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants