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(generateMetadata): update code blocks to include filename #67745

Merged
merged 2 commits into from
Jul 15, 2024
Merged

docs(generateMetadata): update code blocks to include filename #67745

merged 2 commits into from
Jul 15, 2024

Conversation

Juneezee
Copy link
Contributor

On the generateMetadata page 1, the code blocks in "robots" 2 and "Types" 3 section do not have the filename prop.

According to the Docs Contribution Guide 4, code blocks should include the filename prop for clarity.

Footnotes

  1. https://nextjs.org/docs/app/api-reference/functions/generate-metadata

  2. https://nextjs.org/docs/app/api-reference/functions/generate-metadata#robots

  3. https://nextjs.org/docs/app/api-reference/functions/generate-metadata#types

  4. https://nextjs.org/docs/community/contribution-guide#language-and-filename

The code blocks in "robots" [1] and "Types" [2] section do not have the
`filename` prop.

According to the Docs Contribution Guide [3], code blocks should include
the `filename` prop for clarity.

[1]: https://nextjs.org/docs/app/api-reference/functions/generate-metadata#robots
[2]: https://nextjs.org/docs/app/api-reference/functions/generate-metadata#types
[3]: https://nextjs.org/docs/community/contribution-guide#language-and-filename

Signed-off-by: Eng Zer Jun <[email protected]>
@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Jul 14, 2024
@ijjk
Copy link
Member

ijjk commented Jul 14, 2024

Allow CI Workflow Run

  • approve CI run for commit: 8a90c10

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

1 similar comment
@ijjk
Copy link
Member

ijjk commented Jul 14, 2024

Allow CI Workflow Run

  • approve CI run for commit: 8a90c10

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

Copy link
Member

@devjiwonchoi devjiwonchoi left a comment

Choose a reason for hiding this comment

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

Thank you for the PR!

@devjiwonchoi devjiwonchoi enabled auto-merge (squash) July 15, 2024 05:36
@devjiwonchoi devjiwonchoi merged commit d888461 into vercel:canary Jul 15, 2024
34 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Related to Next.js' official documentation. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants