Skip to content

examples: update README.md in mdx example#73454

Merged
samcx merged 1 commit intovercel:canaryfrom
JamBalaya56562:app-dir-mdx
Jan 14, 2025
Merged

examples: update README.md in mdx example#73454
samcx merged 1 commit intovercel:canaryfrom
JamBalaya56562:app-dir-mdx

Conversation

@JamBalaya56562
Copy link
Contributor

@JamBalaya56562 JamBalaya56562 commented Dec 3, 2024

Description

mdx example 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

@ijjk ijjk added the examples Issue was opened via the examples template. label Dec 3, 2024
@ijjk
Copy link
Member

ijjk commented Dec 3, 2024

Allow CI Workflow Run

  • approve CI run for commit: 634d253

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

@JamBalaya56562 JamBalaya56562 force-pushed the app-dir-mdx branch 2 times, most recently from 5a7a63f to 0c2bf88 Compare December 3, 2024 23:52
@ijjk ijjk added the tests label Dec 3, 2024
@JamBalaya56562 JamBalaya56562 force-pushed the app-dir-mdx branch 6 times, most recently from 2b372df to 7f4d3a6 Compare December 13, 2024 00:43
@JamBalaya56562 JamBalaya56562 force-pushed the app-dir-mdx branch 2 times, most recently from 171056f to cb8d03b Compare December 16, 2024 01:51
@JamBalaya56562 JamBalaya56562 changed the title examples: update README.md in app-dir-mdx example examples: update README.md in mdx example Jan 14, 2025
@samcx samcx self-requested a review January 14, 2025 05:08
Copy link
Member

@samcx samcx 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 submitting a PR!

:lgtm:

@samcx samcx merged commit 78d5128 into vercel:canary Jan 14, 2025
44 checks passed
@JamBalaya56562 JamBalaya56562 deleted the app-dir-mdx branch January 14, 2025 05:21
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

examples Issue was opened via the examples template. locked tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants