Skip to content

docs: add migration guide for svgo v4 #2119

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

Merged
merged 1 commit into from
May 5, 2025
Merged

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented May 5, 2025

The SVGO v4.0.0 release should be coming out soon, so we need to formalize all of the breaking changes into a document to help users with migrations from v3 to v4.

My hope was that there'd be so little that the release notes could adequately cover it, however there are quite a few breaking changes now, and the release notes are far too verbose to be practical to apply all at once.

The migration guide is a concise version of the release notes, with breaking changes only, and favors instructions over explanations. Users are of course welcome to refer to the release notes, pull request, or create an issue to seek more information.

Documentation

  • Adds a "Migration" section with the first migration page for v3 to v4. I'll iterate on this over time until SVGO v4 has actually been released.
  • Renames the removeScriptElement page to removeScripts.
    • We've already got a PR in svg/svgo.dev to add a redirect.
  • Drop the Exports section under the Node.js and Browser pages. These are already being maintained in JSDoc and types. Rather than maintaining it in yet another place, I would prefer for users to use their intellisense. Alternatively, we could later export our API to web-based documentation. Anything but maintaining it manually.

Chores

  • Use a more concise syntax for the minium Node.js version.

Related

@SethFalco SethFalco merged commit 75dc22b into svg:main May 5, 2025
14 checks passed
@SethFalco SethFalco deleted the docs-migration branch May 5, 2025 16:27
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.

1 participant