Docs: Remove mentions of MDX 2 #25675
Merged
Conversation
This file contains 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
kylegach
added
documentation
ci:docs
kylegach
force-pushed
the
docs-mdx-3
branch
2 times, most recently
from
b9b5834 to
33e7269
Compare
JReinhold
approved these changes
Jan 20, 2024
docs/faq.md
Outdated
|
|
||
| MDX 2 introduced some changes to how the code is rendered. For example, if you enabled it in your Storybook and you have the following code block: | ||
| MDX 2 introduced some changes to how the code is rendered. For example, if you have the following code block: |
There was a problem hiding this comment.
We still mention MDX 2 here. MDX 3 introduced changes too - I wonder if we should make this section more general?
jonniebigodes
approved these changes
Jan 22, 2024
There was a problem hiding this comment.
Thanks for the updates on the documentation, @kylegach. All is good on my end. Merge when able.
- Remove Breaking changes section - Move GFM instructions to Troubleshooting section - Remove blockquotes, which render in a huge font
14 tasks
stof
reviewed
Mar 27, 2024
| @@ -151,70 +151,7 @@ In addition to Doc Blocks, MDX can incorporate arbitrary React components, makin | |||
|
|
|||
| ### Known limitations | |||
|
|
|||
| While MDX2 supports a variety of runtimes ([React](https://mdxjs.com/packages/react/), [Preact](https://mdxjs.com/packages/preact/), [Vue](https://mdxjs.com/packages/vue/)), Storybook’s implementation is React-only. That means your documentation is rendered in React, while your stories render in the runtime of your choice (React, Vue, Angular, Web Components, Svelte, etc.). | |||
|
|
|||
| ## Breaking changes | |||
There was a problem hiding this comment.
this section is still referenced by a link above (see line 124)
|
|
||
| <!-- prettier-ignore-end --> | ||
|
|
||
| ### Lack of GitHub Flavored Markdown (GFM) |
There was a problem hiding this comment.
This section is referenced by a migration when running storybook upgrade. Its removal makes things quite confusing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
Checklist for Contributors
Testing
Manual testing
docs-mdx-3Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>