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

docs: fix broken link #284

Merged
merged 2 commits into from
Nov 29, 2024
Merged

docs: fix broken link #284

merged 2 commits into from
Nov 29, 2024

Conversation

benmccann
Copy link
Member

closes #283

Copy link

changeset-bot bot commented Nov 8, 2024

⚠️ No Changeset found

Latest commit: 122702e

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

@benmccann benmccann added the documentation Improvements or additions to documentation label Nov 8, 2024
@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-cli-284-svelte.vercel.app/

this is an automated message

@@ -2,7 +2,7 @@
title: sv migrate
---

`sv migrate` migrates Svelte(Kit) codebases. It delegates to the [`svelte-migrate`](https://github.com/sveltejs/kit/blob/main/packages/migrate) package.
`sv migrate` migrates Svelte(Kit) codebases. It delegates to the [`svelte-migrate`](npmjs.com/package/svelte-migrate) package.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`sv migrate` migrates Svelte(Kit) codebases. It delegates to the [`svelte-migrate`](npmjs.com/package/svelte-migrate) package.
`sv migrate` migrates Svelte(Kit) codebases. It delegates to the [`svelte-migrate`](https://www.npmjs.com/package/svelte-migrate) package.

But also: Would it be more helpful to link to the location of the package in this repo, rather than to npm?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for catching this!

But also: Would it be more helpful to link to the location of the package in this repo, rather than to npm?

I don't think so, which is why I changed it. Is there a reason you think that might be more helpful?

Copy link
Member

Choose a reason for hiding this comment

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

Is it even worth to mention that in the docs? It's more of an internal thing for me at least. Also does not look like we have a similar sentence for check in the docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

There are lots of articles, blog posts, tweets, etc. mentioning the two, so I think it's helpful for users to know what the difference is between them and how they relate

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm. But I guess all the docs have been updated to refer to sv, so maybe the more important place to put this is the svelte-migrate readme

@manuel3108 manuel3108 merged commit 478b72c into main Nov 29, 2024
5 checks passed
@manuel3108 manuel3108 deleted the benmccann-patch-2 branch November 29, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The link to svelte-migrate in the docs is broken
4 participants