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 docs links in MDX README #5741

Merged
merged 2 commits into from
Jan 4, 2023
Merged

Fix docs links in MDX README #5741

merged 2 commits into from
Jan 4, 2023

Conversation

delucis
Copy link
Member

@delucis delucis commented Jan 4, 2023

Changes

Makes some links to our docs site in the MDX integration README absolute instead of relative, which won’t work on GitHub & npm (or in docs where we prefix relative links with the GitHub base for consistency).

Testing

n/a docs only

Docs

All docs!

@delucis delucis requested a review from a team as a code owner January 4, 2023 10:41
@changeset-bot
Copy link

changeset-bot bot commented Jan 4, 2023

🦋 Changeset detected

Latest commit: 33be9f9

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jan 4, 2023
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

LGTM @delucis! A small console.log() inside the generation script confirms these are the only links broken, everything should work now 🙌

@delucis delucis merged commit 000d3e6 into main Jan 4, 2023
@delucis delucis deleted the chris/fix-mdx-readme-links branch January 4, 2023 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants