Skip to content

Conversation

@connorshea
Copy link
Contributor

@connorshea connorshea commented Dec 2, 2025

Made a few minor tweaks to the gist I wrote, still need to fill out the page to address a few TODOs

TODO:

  • clarify/flesh out editor section
  • Add code blocks/commands for other pkg managers

@netlify
Copy link

netlify bot commented Dec 2, 2025

Deploy Preview for oxc-project ready!

Name Link
🔨 Latest commit 1b6613d
🔍 Latest deploy log https://app.netlify.com/projects/oxc-project/deploys/6934cc35e610120008f2ef28
😎 Deploy Preview https://deploy-preview-676--oxc-project.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@leaysgur
Copy link
Member

leaysgur commented Dec 2, 2025

Slightly updated:

  • Use Oxfmt as product name vs Prettier, use oxfmt in command
  • Wrap filename with `
  • Apply diff syntax for shorter comparison
  • Reduce height by arranging headings

@connorshea connorshea changed the title docs: Add a WIP docs page for migrating from Prettier to oxfmt. docs: Add a docs page for migrating from Prettier to oxfmt. Dec 2, 2025
@leaysgur
Copy link
Member

leaysgur commented Dec 2, 2025

Add code blocks/commands for other pkg managers

The 7-steps felt too long and likely to lower CVR for me 🙈, so just resolved this by removing them.

Copy link
Member

@leaysgur leaysgur left a comment

Choose a reason for hiding this comment

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

I think basic flow is fine! 😉

However, I'd like to simplify and shorten the text overall. Some sentences might even be okay to omit entirely.

Would you mind giving it a try?

The editor integration feels like it could easily fill a whole page on its own... 😅
Let's split it into separate page later and just include a link here for now.

@connorshea
Copy link
Contributor Author

connorshea commented Dec 2, 2025

However, I'd like to simplify and shorten the text overall. Some sentences might even be okay to omit entirely.

Maybe we can replace the caveats section with a link to the FAQ? We should probably add a few of these caveats to the FAQ as well anyway. I think most of the rest of the page is necessary to avoid users running into problems with the migration process (plus I assume a lot of people will use Claude or Copilot to migrate their projects, so giving it as much info as we can is useful for that). I'll take a swing at updating the text tomorrow.

Let's split it into separate page later and just include a link here for now.

So cut the editor part down to just a link to the editor question in the FAQ? That sounds good to me 👍

@leaysgur
Copy link
Member

leaysgur commented Dec 2, 2025

Thank you in advance! 🙌🏻

just a link to the editor question in the FAQ?

Yes, if necessary, update that section and/or split out the editor-integration.md, etc.

connorshea and others added 8 commits December 6, 2025 17:11
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Yuji Sugiura <6259812+leaysgur@users.noreply.github.com>
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Yuji Sugiura <6259812+leaysgur@users.noreply.github.com>
Replace the editor section with a link to the FAQ.

Simplify the page about migrating and remove some less-relevant parts.
@connorshea
Copy link
Contributor Author

We could probably remove/shorten this part, since the 0.17.0 update on Monday will resolve a large part of this: The Oxfmt alpha only supports formatting JavaScript and TypeScript files (including those with JSX syntax). If you need support for non-JSX frameworks like Vue or Ember, or other languages like JSON, YAML, or Markdown, you will likely want to wait.

But otherwise I think I've shortened it as much as I can without removing relevant info. So, ready for re-review :)

@Boshen Boshen merged commit fd8b30d into main Dec 7, 2025
7 checks passed
@Boshen Boshen deleted the migrate-doc branch December 7, 2025 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants