From 029ad1ee7428be9cefc39e961c000dd8876bb347 Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Sun, 11 Aug 2024 21:51:14 +0200 Subject: [PATCH] docs: Add instructions for opting in and out of nightly builds (#748) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### ๐Ÿ”— Linked issue ### ๐Ÿ“š Description Final step to fix #562 --- docs/content/1.getting-started/1.setup.md | 36 +++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/content/1.getting-started/1.setup.md b/docs/content/1.getting-started/1.setup.md index ce8d1355..9bc906dc 100644 --- a/docs/content/1.getting-started/1.setup.md +++ b/docs/content/1.getting-started/1.setup.md @@ -37,6 +37,42 @@ That's it! You can now use `Storybook` in your Nuxt app โœจ Discover your Stories directly with the `Storybook Devtools tab`. :: +### Nightly Builds + +The nightly release channel allows you to test the latest updates and features, directly from the most recent commits. This is useful for experimenting with new features, improvements, and bug fixes before they are included in the stable release. + +#### Opting in to the nightly release + +To use the nightly version, follow these steps: + +- Modify the `@nuxtjs/storybook` dependency in your `package.json` to use the latest nightly release: + + ```json + { + "devDependencies": { + "nuxt": "npm:@nuxtjs/storybook@nightly" + } + } + ``` + +- Remove the lockfile and reinstall the dependencies using your package manager to ensure the nightly release is installed. + +#### Opting out of the nightly release + +If you need to revert to the stable release, follow these steps: + +- Change the `@nuxtjs/storybook` dependency in `package.json` back to the stable version: + + ```json + { + "devDependencies": { + "@nuxtjs/storybook": "latest" + } + } + ``` + +- Remove the lockfile and reinstall the dependencies to revert to the stable release. + ## Storybook config Files When running `npm run dev`, this module will look for these files: