ember.js icon indicating copy to clipboard operation
ember.js copied to clipboard

[Bug] ember API documentation has broken links to node_modules

Open geneukum opened this issue 2 years ago β€’ 2 comments

🐞 Describe the Bug

Some API documentation hosted under https://api.emberjs.com/ember/4.4 references paths under node_modules in the "Defined in" tag. Clicking the link results in an error on GitHub about the repository not containing a file at that path.

πŸ”¬ Minimal Reproduction

  1. Open the documentation for RSVP's All function.
  2. Click the "Defined in node_modules/rsvp/lib/rsvp/all.js:3" link.

πŸ˜• Actual Behavior

After clicking the link from the Minimal Reproduction section above, GitHub shows a 404 error and displays the message: "The 'emberjs/ember.js' repository doesn't contain the 'node_modules/rsvp/lib/rsvp/all.js' path in 'v4.4.0'."

πŸ€” Expected Behavior

Either exclude documentation coming from node_modules from the published bundle or tweak the implementation so that we end up with working links.

geneukum avatar May 29 '22 13:05 geneukum

@emberjs/learning-team-managers

chancancode avatar Jun 22 '22 18:06 chancancode

Thanks for reporting!

One additional option is to make a small change in the app to omit this link or point it to RSVP directly.

My understanding is that RSVP available to use through Ember, but it’s a separate package.

jenweber avatar Jun 23 '22 13:06 jenweber