Skip to content

Update integrations to MDX syntax#5978

Merged
sarah11918 merged 15 commits into
mainfrom
update-integrations
Dec 30, 2023
Merged

Update integrations to MDX syntax#5978
sarah11918 merged 15 commits into
mainfrom
update-integrations

Conversation

@ElianCodes
Copy link
Copy Markdown
Member

Description (required)

Updates all integration guides to use MDX & Expressive Code syntax, instead of regular MD.

More info on the HackMD

Co-authored-by: HiDeoo <HiDeoo@users.noreply.github.com>
Co-authored-by: Reuben Tier <TheOtterlord@users.noreply.github.com>
Co-authored-by: Jeffrey Johnston <Coffee-Nerd@users.noreply.github.com>
Co-authored-by: Atharva Pise <atharvapise19@gmail.com>
Co-authored-by: Luiz Ferraz <luiz@lferraz.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ElianCodes ElianCodes added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Dec 28, 2023
@ElianCodes ElianCodes self-assigned this Dec 28, 2023
@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 28, 2023

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Dec 30, 2023 6:06pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Visit Preview Dec 30, 2023 6:06pm

@sarah11918
Copy link
Copy Markdown
Member

@VoxelMC We missed you on Talking and Doc'ing today! This PR is "done" but needs careful reviewing! I'm sure there's stuff missed, or still to decide. The link to the HackMD explains what we did. Care to take a look over this one?

@sarah11918 sarah11918 marked this pull request as ready for review December 28, 2023 16:49
@VoxelMC
Copy link
Copy Markdown
Contributor

VoxelMC commented Dec 28, 2023

@VoxelMC We missed you on Talking and Doc'ing today! This PR is "done" but needs careful reviewing! I'm sure there's stuff missed, or still to decide. The link to the HackMD explains what we did. Care to take a look over this one?

Yes! Definitely. I will be available to later today, looking forward to it!

@sarah11918 sarah11918 added the help - leave feedback Let's crowd source this one! Looking for comments, suggestions, LGTMs! label Dec 28, 2023
@alexanderniebuhr alexanderniebuhr self-requested a review December 28, 2023 18:26
Copy link
Copy Markdown
Member

@alexanderniebuhr alexanderniebuhr left a comment

Choose a reason for hiding this comment

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

Added some comments for the Cloudflare adapter. Except one I don't think those are blocking, but I would love to get solved, why the ins seem not to work for the one block.

Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
@VoxelMC
Copy link
Copy Markdown
Contributor

VoxelMC commented Dec 28, 2023

Slowly working on a review to (hopefully) use Expressive Code to full capacity! Hope to have it done soon :)

Comment thread src/content/docs/en/guides/integrations-guide/alpinejs.mdx
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Copy link
Copy Markdown
Contributor

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

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

Just added some suggestions.

Copy link
Copy Markdown
Member

@at-the-vr at-the-vr left a comment

Choose a reason for hiding this comment

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

Got some suggestions for the integrations I took yesterday and 1 minor nit ⬇️

  • Certain fragments in the modified files use ```sh and others use ```shell, both of them work 💯 but thought to point it out. Example: install/auto uses "```shell" in its fragments

Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/vue.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/mdx.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/mdx.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/netlify.mdx Outdated
Copy link
Copy Markdown
Contributor

@VoxelMC VoxelMC left a comment

Choose a reason for hiding this comment

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

Absolutely fantastic work to everyone who worked on this! Elian, Otterlord, HiDeoo, Atharva, Sarah, Fryuni, and Coffee-Lord! And all of the reviewers so far, too.

I truly feel like the integration docs are FAR more Expressive!~

Anyways, I left some comments about potential changes to expressive-ness, and some formatting fixing (if they haven't been rectified already).

Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx
Comment thread src/content/docs/en/guides/integrations-guide/vercel.mdx
Comment thread src/content/docs/en/guides/integrations-guide/tailwind.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/cloudflare.mdx Outdated
Copy link
Copy Markdown
Member

@alexanderniebuhr alexanderniebuhr left a comment

Choose a reason for hiding this comment

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

Added some comments :re the Netlify adapter

Comment thread src/content/docs/en/guides/integrations-guide/netlify.mdx
Comment thread src/content/docs/en/guides/integrations-guide/netlify.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/netlify.mdx
Comment thread src/content/docs/en/guides/integrations-guide/netlify.mdx
@sarah11918
Copy link
Copy Markdown
Member

I wish I could @everyone here in a PR!

Thank you, "everyone" for such care and attention! I'm going to:

  • commit the suggestions I can and resolve conversations
  • leave the comments OPEN for things that could not be edited/suggested because you couldn't change that part of the file
  • Edit the file directly and add the open comments so I can resolve more of them
  • Let @VoxelMC make a PR to this branch to standardize the opening / Install sections
  • ... see where we are by then. 😅

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>
Co-authored-by: Atharva Pise <atharvapise19@gmail.com>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
@sarah11918 sarah11918 merged commit 9ecadb8 into main Dec 30, 2023
@sarah11918 sarah11918 deleted the update-integrations branch December 30, 2023 18:26
ematipico pushed a commit that referenced this pull request Jan 26, 2024
Co-authored-by: HiDeoo <HiDeoo@users.noreply.github.com>
Co-authored-by: Reuben Tier <TheOtterlord@users.noreply.github.com>
Co-authored-by: Jeffrey Johnston <Coffee-Nerd@users.noreply.github.com>
Co-authored-by: Atharva Pise <atharvapise19@gmail.com>
Co-authored-by: Luiz Ferraz <luiz@lferraz.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>
Co-authored-by: voxel!() <voxelmc@hotmail.com>
Co-authored-by: Alexander Niebuhr <45965090+alexanderniebuhr@users.noreply.github.com>
Co-authored-by: Favour Okoh <87978245+Favourz1@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

help - leave feedback Let's crowd source this one! Looking for comments, suggestions, LGTMs! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants