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: Fixes found during 8.5 QA #30103

Merged
merged 4 commits into from
Dec 30, 2024
Merged

Docs: Fixes found during 8.5 QA #30103

merged 4 commits into from
Dec 30, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Dec 18, 2024

What I did

  • Add configDir option to example configs
  • Move coverage exclusion config under Set up heading
    • Add **/.storybook/**
  • Correct viteFinal guidance
  • Add MSW version requirement
  • Add webpack-to-vite migration guidance

Checklist for Contributors

Testing

Manual testing

Sync this branch with locally running docs site

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make 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.

Greptile Summary

Updates documentation for Vitest plugin and test coverage configuration in Storybook 8.5, improving clarity and organization of setup instructions.

  • Added configDir option in docs/_snippets/vitest-plugin-vitest-config.md and vitest-plugin-vitest-workspace.md for React, Vue, and Svelte frameworks
  • Moved coverage exclusion settings from 'Troubleshooting' to 'Set up' section in docs/writing-tests/test-coverage.mdx
  • Added **/.storybook/** to coverage exclusion patterns
  • Added placeholder comments in docs/writing-tests/test-addon.mdx to indicate additional configuration options in storybookTest plugin

💡 (3/5) Reply to the bot's comments like "Can you suggest a fix for this @greptileai?" or ask follow-up questions!

- Add `configDir` option to example configs
- Move coverage exclusion config under Set up heading
    - Add `**/.storybook/**`
@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Dec 18, 2024
@kylegach kylegach self-assigned this Dec 18, 2024
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, 1 comment(s)
Edit PR Review Bot Settings | Greptile

docs/writing-tests/test-addon.mdx Show resolved Hide resolved
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, 1 comment(s)
Edit PR Review Bot Settings | Greptile

docs/writing-tests/test-coverage.mdx Show resolved Hide resolved
Copy link

nx-cloud bot commented Dec 18, 2024

View your CI Pipeline Execution ↗ for commit 50a61c5.

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

☁️ Nx Cloud last updated this comment at 2024-12-27 21:18:01 UTC

@kylegach kylegach changed the title Docs fixes found during 8.5 QA Docs: Fixes found during 8.5 QA Dec 18, 2024
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.

LGTM

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

@valentinpalkovic valentinpalkovic merged commit 2cb8bdb into next Dec 30, 2024
9 of 11 checks passed
@valentinpalkovic valentinpalkovic deleted the 8-5-docs-fixes branch December 30, 2024 09:28
@github-actions github-actions bot mentioned this pull request Dec 30, 2024
13 tasks
framework: '@storybook/your-framework',
stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
async webpackFinal(config) {
storybookBaseConfig.module?.rules?.push({
Copy link
Member

Choose a reason for hiding this comment

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

@kylegach I assume you wanted to call this config instead?

async viteFinal(config) {
return {
...config,
plugins: [...(config.plugins ?? []), graphql()],
Copy link
Member

Choose a reason for hiding this comment

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

@kylegach did you mean to add the import for the graphql plugin? or does it just represent the concept of a plugin?

kylegach added a commit that referenced this pull request Jan 2, 2025
@kylegach kylegach mentioned this pull request Jan 2, 2025
4 tasks
@kylegach
Copy link
Contributor Author

kylegach commented Jan 2, 2025

Thanks, @yannbf. Fixed in #30176.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants