Conversation
jonniebigodes
added
documentation
ci:docs
☁️ Nx Cloud ReportCI is running/has finished running commands for commit f922ed1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
30 file(s) reviewed, 50 comment(s)
Edit PR Review Bot Settings | Greptile
jonniebigodes
added
the
patch:yes
| ```js filename="Page.stories.js" renderer="svelte" language="js" | ||
| ```svelte filename="Page.stories.svelte" renderer="svelte" language="js" tabTitle="Svelte CSF" | ||
| <!-- TK: vet this against recommendation and apply it to the other languages (eg., ts-4-9, ts) --> | ||
| ``` |
There was a problem hiding this comment.
note that TypeScript will complain here, because it doesn't know that this is doable, but it works fine at runtime.
| #### Automatic migration | ||
|
|
||
| When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/sveltekit`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below. | ||
| {/* TK: Vet this for accuracy, the migration never prompted me to opt-in to the @storybook/sveltekit package, instead it updated the package version. Additionally the example refers to svelte-vite, not sveltekit */} |
| Update your Storybook configuration file (i.e., `.storybook/main.js|ts`) to enable support for this format. | ||
|
|
||
| {/* prettier-ignore-start */} | ||
|
|
||
| <CodeSnippets path="main-config-csf-addon-register.md" /> | ||
| <CodeSnippets path="main-config-svelte-csf-register.md" /> | ||
|
|
||
| {/* prettier-ignore-end */} |
There was a problem hiding this comment.
This is redundant with what is available at /addons/install-addons.mdx#manual-installation.
I do not think we should set a precedent for including this every time we document the add command, as that will balloon maintenance efforts.
…js/storybook into docs_adjust_svelte_snippets_v5
JReinhold
left a comment
JReinhold
left a comment
There was a problem hiding this comment.
Everything is good on my side.
Massive work @jonniebigodes 👏👏👏
|
@JReinhold, thank you very much for the assistance and help on this pull request 🙏 ! |
…s_v5 Docs: Svelte CSF snippets (cherry picked from commit c7569a6)
github-actions
bot
added
the
patch:done
ndelangen
removed
the
patch:yes
5 participants
With this pull request, the documentation was updated to contain the first batch of Svelte CSF snippets.
What was done:
native-formatsnippetsChecklist for Contributors
Manual testing
docs_adjust_svelte_snippets_v5webreponpm run sync-docsnpm run devDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.@JReinhold, when you have a moment, can you fact-check this and provide some guidance on some of the items? They are tagged accordingly with comments. Thanks in advance.
Greptile Summary
This PR updates Storybook's documentation to modernize Svelte examples by replacing old native-format snippets with new Component Story Format (CSF) examples across multiple documentation files.
@storybook/addon-svelte-csfpackage anddefineMetafunction