Skip to content

docs: add-on docs #546

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 7 commits into from
Apr 25, 2025
Merged

docs: add-on docs #546

merged 7 commits into from
Apr 25, 2025

Conversation

benmccann
Copy link
Member

I started from the base provided in #272

I don't know if this needs to be perfect, but it's nice to have something and a base to work off of

Please check where I gave examples of executing the add-ons with options as I think I probably got the syntax wrong for some of them

@benmccann benmccann added the documentation Improvements or additions to documentation label Apr 23, 2025
Copy link

changeset-bot bot commented Apr 23, 2025

⚠️ No Changeset found

Latest commit: e5caf16

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 link

pkg-pr-new bot commented Apr 23, 2025

Open in StackBlitz

npx https://pkg.pr.new/sveltejs/cli/sv@546
npx https://pkg.pr.new/sveltejs/cli/svelte-migrate@546

commit: e5caf16

@manuel3108 manuel3108 mentioned this pull request Apr 24, 2025
Copy link
Member

@manuel3108 manuel3108 left a comment

Choose a reason for hiding this comment

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

We should probably also link the add-on pages from here: https://svelte-dev-git-preview-cli-546-svelte.vercel.app/docs/cli/sv-add#Official-add-ons

As you said, this is a good starting point, and I think we should move forward with this.

@JReinhold
Copy link
Contributor

JReinhold commented Apr 24, 2025

Looks great! We'd be happy to contribute more to the Storybook page, if you have a good idea of what kind of content you want in there, and how much/little/none at all.

sv is sort of already automatically covering the Getting Started portion, but potentially the next step could make sense to document? How to run stuff, how to learn more, introduction tutorials, etc.? Maybe a few sentences on why you'd want to use the tool.
Just braindumping.

@manuel3108
Copy link
Member

I don't think we have thought that through entirely now, but I think everything you wrote kind of makes sense. Personally I don't think the page should actuall contain the tutorials itself, (apart from a really basic example) but maybe links to the storybook docs or something

@manuel3108 manuel3108 merged commit 3d2ac28 into main Apr 25, 2025
7 checks passed
@manuel3108 manuel3108 deleted the add-on-docs branch April 25, 2025 19:05
@JReinhold
Copy link
Contributor

Personally I don't think the page should actuall contain the tutorials itself, (apart from a really basic example) but maybe links to the storybook docs or something

yeah I agree, that was also what I meant, but I was too brief 😅

like basic examples, basic why/value prop, and then a handful of links to learn more.

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.

3 participants