Skip to content

Commit

Permalink
docs: Add instructions for opting in and out of nightly builds (#748)
Browse files Browse the repository at this point in the history
<!--
☝️ PR title should follow conventional commits
(https://conventionalcommits.org).
In particular, the title should start with one of the following types:

- docs: 📖 Documentation (updates to the documentation or readme)
- fix: 🐞 Bug fix (a non-breaking change that fixes an issue)
- feat: ✨ New feature/enhancement (a non-breaking change that adds
functionality or improves existing one)
- feat!/fix!: ⚠️ Breaking change (fix or feature that would cause
existing functionality to change)
- chore: 🧹 Chore (updates to the build process or auxiliary tools and
libraries)
-->

### 🔗 Linked issue

<!-- If it resolves an open issue, please link the issue here. For
example "Resolves #123" -->

### 📚 Description

Final step to fix #562

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
  • Loading branch information
tobiasdiez authored Aug 11, 2024
1 parent 5f74c25 commit 029ad1e
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/content/1.getting-started/1.setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 029ad1e

Please sign in to comment.