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: Add Preact-vite framework docs #30271

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

shilman
Copy link
Member

@shilman shilman commented Jan 16, 2025

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@shilman shilman added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch preact ci:docs Run the CI jobs for documentation checks only. labels Jan 16, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

4 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile


### In a project without Storybook

Follow the prompts after running this command in your React project's root directory:
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: 'React project' should be 'Preact project' since this is Preact-specific documentation

* 🪄 Zero config
* 💫 and more!

<If notRenderer="Preact">
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: Case mismatch in notRenderer="Preact" - should be lowercase 'preact' to match renderer="preact" usage below

Comment on lines +1 to +7
```js filename=".storybook/main.js" renderer="react" language="js"
export default {
// ...
// framework: '@storybook/preact-webpack5', 👈 Remove this
framework: '@storybook/preact-vite', // 👈 Add this
};
```
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: renderer should be 'preact' instead of 'react' since this is Preact-specific documentation

Comment on lines +9 to +19
```ts filename=".storybook/main.ts" renderer="react" language="ts"
import { StorybookConfig } from '@storybook/preact-vite';

const config: StorybookConfig = {
// ...
// framework: '@storybook/preact-webpack5', 👈 Remove this
framework: '@storybook/preact-vite', // 👈 Add this
};

export default config;
```
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: renderer should be 'preact' instead of 'react' since this is Preact-specific documentation

Copy link

nx-cloud bot commented Jan 16, 2025

View your CI Pipeline Execution ↗ for commit d88c49b.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 37s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-16 03:34:49 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:yes Bugfix & documentation PR that need to be picked to main branch preact
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant