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

broken docs link #9111

Closed
BryanCrotaz opened this issue Nov 16, 2023 · 3 comments · Fixed by #9160
Closed

broken docs link #9111

BryanCrotaz opened this issue Nov 16, 2023 · 3 comments · Fixed by #9160
Labels
🏷️ doc This PR adds/improves/or fixes documentation

Comments

@BryanCrotaz
Copy link
Contributor

https://api.emberjs.com/ember-data/5.3/modules/@ember-data%2Fjson-api

At the bottom:
For the full list of APIs available read the code documentation for [Ember**Data** Cache](https://github.com/emberjs/data/blob/main/ember-data-types/cache/cache.ts)

This link is broken.

@runspired
Copy link
Contributor

unfortunately links from within the api docs can't tag a specific version of the code on github and on canary that has indeed moved. We should update the link for the next release to the new spot if we haven't yet but not sure there's anything we can do for old spots. @jaredgalanis any thoughts?

@BryanCrotaz
Copy link
Contributor Author

BryanCrotaz commented Nov 16, 2023

I don't think you should refer people to the source - the docs embedded in the source should be surfaced in the api docs. I shouldn't need to read the source code to understand at a "user of the code" level how it works and how to use it.

@runspired
Copy link
Contributor

there's no other option in these situations

@runspired runspired moved this from needs triage to in progress in EmberData Dec 10, 2023
@runspired runspired added the 🏷️ doc This PR adds/improves/or fixes documentation label Dec 10, 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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants