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

Document MDX optimize static logic #7221

Merged
merged 6 commits into from
May 30, 2023
Merged

Document MDX optimize static logic #7221

merged 6 commits into from
May 30, 2023

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented May 26, 2023

Changes

Followup to #7151 (comment) suggested by @ematipico

This adds internal docs on how the MDX optimization feature work.

After writing this out, I have no idea if it makes things clearer 😅 I'm not the best explainer and it could be polished a bit more.

Testing

n/a

Docs

Adds internal documentation for how MDX optimization works.

@bluwy bluwy requested a review from a team as a code owner May 26, 2023 13:12
@changeset-bot
Copy link

changeset-bot bot commented May 26, 2023

⚠️ No Changeset found

Latest commit: a29dc16

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: integration Related to any renderer integration (scope) label May 26, 2023
Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

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

To be honest, I find it really clear, and it helps A LOT!

packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
bluwy and others added 2 commits May 26, 2023 21:33
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
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.

Hey @bluwy, I'm so excited you're writing internal documentation! 🙌

Caught some little grammar things, and tried to point out where I thought flow or structure could be more helpful.

Admittedly, now you're writing stuff that I understand less-well, so there are some things here that sound like they could be improved to my editing ear, but I might not know exactly HOW to do that in this domain.

So, just take my suggestions for consideration, but you'll still have to do the heavy lifting for me. 😅

packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/src/README.md Outdated Show resolved Hide resolved
bluwy and others added 3 commits May 29, 2023 16:28
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@bluwy
Copy link
Member Author

bluwy commented May 29, 2023

Thanks for checking some of my silly mistakes @sarah11918. Sorry you have to go through that, I should run through a grammar checker next time 😅

I've applied most of your suggestions except #7221 (comment) that I'd like to make sure you see it before merging this.

@bluwy bluwy merged commit 29da199 into main May 30, 2023
@bluwy bluwy deleted the document-mdx-static branch May 30, 2023 07: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