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

Fix MDX integration error message not being compatible with docs #5767

Merged
merged 2 commits into from
Jan 5, 2023

Conversation

Princesseuh
Copy link
Member

Changes

Small correction to Ben's previous PR adding a error message when the MDX integration is missing, the format was wrong so docs didn't generate properly.

Also added some info to the README to avoid this situation in the future

Testing

N/A

Docs

Added some info on the technical format to follow for writing error messages

/cc @withastro/maintainers-docs

@Princesseuh Princesseuh requested a review from a team as a code owner January 5, 2023 14:54
@changeset-bot
Copy link

changeset-bot bot commented Jan 5, 2023

⚠️ No Changeset found

Latest commit: adc09ae

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Jan 5, 2023
@Princesseuh Princesseuh changed the title Fix/mdx integration error Fix MDX integration error message not being compatible with docs Jan 5, 2023
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

LGTM! Well spotted 🙌

Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

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

LGTM, nice catch!

@Princesseuh Princesseuh merged commit f1da0da into main Jan 5, 2023
@Princesseuh Princesseuh deleted the fix/mdx-integration-error branch January 5, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants