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

[Bug]: Bad link to doc in starter app #660

Closed
2 of 12 tasks
9gustin opened this issue Nov 25, 2021 · 2 comments
Closed
2 of 12 tasks

[Bug]: Bad link to doc in starter app #660

9gustin opened this issue Nov 25, 2021 · 2 comments
Labels
bug Something isn't working

Comments

@9gustin
Copy link

9gustin commented Nov 25, 2021

Which Remix packages are impacted?

  • remix (Remix core)
  • create-remix
  • @remix-run/architect
  • @remix-run/cloudflare-workers
  • @remix-run/dev
  • @remix-run/express
  • @remix-run/netlify
  • @remix-run/node
  • @remix-run/react
  • @remix-run/serve
  • @remix-run/server-runtime
  • @remix-run/vercel

What version of Remix are you using?

1.0.5

Steps to Reproduce

Create a new remix app, following the documentation:

npx create-remix@latest

Then go to YOUR_APP/app/root.tsx

Expected Behavior

I want to go to the links exported variable documentation

Actual Behavior

In this file you have by default the links variable exported and works fine, but the link to the documentation throw a 404.

Received text:

/**
 * The `links` export is a function that returns an array of objects that map to
 * the attributes for an HTML `<link>` element. These will load `<link>` tags on
 * every route in the app, but individual routes can include their own links
 * that are automatically unloaded when a user navigates away from the route.
 *
 * https://remix.run/api/app#links
 */

And when you navigate to https://remix.run/api/app#links it throws an error

@9gustin 9gustin added the bug Something isn't working label Nov 25, 2021
@mnlfischer
Copy link

mnlfischer commented Nov 25, 2021

The correct Link is https://remix.run/api/conventions#links I think.

@machour
Copy link
Collaborator

machour commented Mar 15, 2022

Not applicable anymore, root.tsx doesn't contain this comment anymore

@machour machour closed this as completed Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants