Skip to content

feat(sv): add setup instructions to README.md#1034

Draft
sacrosanctic wants to merge 3 commits intosveltejs:mainfrom
sacrosanctic:sick-weasel
Draft

feat(sv): add setup instructions to README.md#1034
sacrosanctic wants to merge 3 commits intosveltejs:mainfrom
sacrosanctic:sick-weasel

Conversation

@sacrosanctic
Copy link
Copy Markdown
Contributor

Closes #982

Description

Todo

  • review md.ts
  • review insertEnvMsg
  • reonsider the structure of README.md

Checklist

  • Update snapshots (if applicable)
  • Add a changeset (if applicable)
  • Allow maintainers to edit this PR
  • I care about what I'm doing, no matter the tool I use (Notepad, Sublime, VSCode, AI...)

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 3, 2026

⚠️ No Changeset found

Latest commit: e9d439f

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@svelte-docs-bot
Copy link
Copy Markdown

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 3, 2026

Open in StackBlitz

npx https://pkg.pr.new/svelte-migrate@1034
npx https://pkg.pr.new/sv@1034
npx https://pkg.pr.new/@sveltejs/sv-utils@1034

commit: e9d439f

@sacrosanctic
Copy link
Copy Markdown
Contributor Author

@jycouet WIP, let me know if this is a good direction to take it before I go further.

@jycouet
Copy link
Copy Markdown
Contributor

jycouet commented Apr 4, 2026

@jycouet WIP, let me know if this is a good direction to take it before I go further.

Thank you for starting this, yes I believe that it's going in the good direction.

A few random points

  • you should create packages/sv-utils/src/tests/md.ts to test & probably iterate faster
  • If there is no add-on, we should not have this ## Add-on Setup chapter? or have a message inside like "no addon selected" (to keep the anchor)
  • if I run 2 times the addon, we should not have 2 times the entry
  • The "Add-on Setup", is more "Add-on next step"?
  • in existing project, if Add-on Setup is not there, we should maybe not update the readme at all?

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.

Output from nextSteps should be in README.md

2 participants