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

Update App router documentation links #51661

Closed
wants to merge 2 commits into from
Closed

Update App router documentation links #51661

wants to merge 2 commits into from

Conversation

PinkChampagne17
Copy link

Some links in App router docs still point to Pages router docs, which could confuse users and lead to outdated information. This pull request updates the links to App router documentation.

@vercel-spaces
Copy link

vercel-spaces bot commented Jun 22, 2023

Notifying the following users due to files changed in this PR:

@timneutkens, @ijjk, @shuding, @huozhi, @feedthejim:

docs/02-app/02-api-reference/01-components/link.mdx
docs/02-app/02-api-reference/04-functions/revalidatePath.mdx
docs/02-app/02-api-reference/04-functions/revalidateTag.mdx
docs/02-app/02-api-reference/04-functions/use-router.mdx
docs/02-app/02-api-reference/05-next-config-js/appDir.mdx
docs/02-app/02-api-reference/05-next-config-js/assetPrefix.mdx
docs/02-app/02-api-reference/05-next-config-js/basePath.mdx
docs/02-app/02-api-reference/05-next-config-js/env.mdx
docs/02-app/02-api-reference/05-next-config-js/exportPathMap.mdx
docs/02-app/02-api-reference/05-next-config-js/headers.mdx
docs/02-app/02-api-reference/05-next-config-js/images.mdx
docs/02-app/02-api-reference/05-next-config-js/output.mdx
+4 more

This comment was posted based on the notify modifier.

@tyler-lutz
Copy link
Contributor

I noticed this as well. The problem is that these pages are shared between the app and pages router documentation, so changing them to app would mean they would link to the app router on the pages documentation. I was planning to go through all the shared documentation and separating all the links into and so that there isn't a bunch of switching between the routers when going through the links.

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems correct at first but I think its going to have the opposite issue since a lot of the docs are the same for Pages and App Router.

For example, see these two:

I'll defer to @delbaoliveira here since we need a way to link the two related pages together.

@delbaoliveira
Copy link
Contributor

delbaoliveira commented Jun 23, 2023

For now, you can wrap the links with the <AppOnly> and <PagesOnly> components, and these will get filtered out depending on which option is selected. However, it does mean we'll need two links.

@tyler-lutz
Copy link
Contributor

@delbaoliveira I made another pull request for this. #51733

@styfle
Copy link
Member

styfle commented Jun 27, 2023

Closing in favor of #51733

@styfle styfle closed this Jun 27, 2023
@PinkChampagne17 PinkChampagne17 deleted the update-doc-links branch June 28, 2023 01:24
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants