examples: update README.md in mdx example#73454
Merged
samcx merged 1 commit intovercel:canaryfrom Jan 14, 2025
Merged
Conversation
Member
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
5a7a63f to
0c2bf88
Compare
2b372df to
7f4d3a6
Compare
171056f to
cb8d03b
Compare
cb8d03b to
634d253
Compare
app-dir-mdx examplemdx example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
mdxexample README.md is inaccurate.For instance, API routes is described even though it does not exist.
In conclusion, I rewrote the README.md following example guidelines.
CC: @samcx
Adding or Updating Examples
pnpm build && pnpm lint. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md