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

Update mdx integration docs for v3 #8151

Merged
merged 6 commits into from
May 8, 2024
Merged

Update mdx integration docs for v3 #8151

merged 6 commits into from
May 8, 2024

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented May 2, 2024

Description (required)

Update the docs for the MDX integration's next major (v3). The main change is the rename of optimize.customComponentNames -> optimize.ignoreElementNames.

There's some other technically breaking changes listed in the linked PR below, but I don't think it will affect most users, so I didn't add a new migration section.

Related issues & labels (optional)

For Astro version: 4.8. See astro PR withastro/astro#10935

@bluwy bluwy added improve documentation Enhance existing documentation (e.g. add an example, improve description) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! labels May 2, 2024
Copy link

vercel bot commented May 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview May 8, 2024 3:42pm
1 Ignored Deployment
Name Status Preview Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) May 8, 2024 3:42pm

@astrobot-houston
Copy link
Contributor

astrobot-houston commented May 2, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en guides/integrations-guide/mdx.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

This looks great @bluwy ! I just used our <Since> component to call attention to the change with the new version, which will need to be imported at the top of the file, (which I can't just suggest here in GitHub):

import Since from '~/components/Since.astro';

src/content/docs/en/guides/integrations-guide/mdx.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label May 3, 2024
@sarah11918 sarah11918 added this to the 4.8 milestone May 3, 2024
bluwy and others added 2 commits May 6, 2024 00:44
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looks great! Ready for 4.8 💪

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label May 5, 2024
@sarah11918
Copy link
Member

Updating branch and pointing to new 4.8.0 branch

@sarah11918 sarah11918 merged commit 04d4db4 into 4.8.0 May 8, 2024
2 of 3 checks passed
@sarah11918 sarah11918 deleted the mdx-v3 branch May 8, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants