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: remove invalid og image cases #66355

Merged
merged 1 commit into from
May 29, 2024

Conversation

huozhi
Copy link
Member

@huozhi huozhi commented May 29, 2024

What

Removing the /[...catchall]/<metadata image convention>.js case from docs

Why

Since og image and icon routes are using catch-all routes to handle the both single or multiple routes. For instance:

app/opengraph-image.js can possibly generate two cases:

  • single route: /opengraph-image
  • multi routes with generateImageMetadata(): /opengraph-image/[id]

We're not able to detect if there's generateImageMetadata defined in the file before mapping the routes, and decided to create the different routes to either /opengraph-image or /opengraph-image/[id]. That's why we're using a catch-all routes to handle them rn.

Related #48106
Related #57349

@huozhi huozhi requested review from timeyoutakeit and leerob and removed request for a team May 29, 2024 22:13
@ijjk ijjk added created-by: Next.js team PRs by the Next.js team Documentation Related to Next.js' official documentation. labels May 29, 2024
@samcx samcx merged commit 5747afd into canary May 29, 2024
35 checks passed
@samcx samcx deleted the docs/remove-the-invalid-og-image-cases branch May 29, 2024 23:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Next.js team PRs by the Next.js team Documentation Related to Next.js' official documentation. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants