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: CSF Factories fixes #30589

Merged
merged 7 commits into from
Feb 20, 2025
Merged

Docs: CSF Factories fixes #30589

merged 7 commits into from
Feb 20, 2025

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Feb 19, 2025

What I did

  • Fix incorrect subpath imports snippet
  • Prose tweaks
  • Add migration instructions for Vitest setup file
  • Remove mentions of codemod

Checklist for Contributors

Testing

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Sync this branch with locally running docs
  2. Review updated pages

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 CSF Factories, removing automated migration tooling and clarifying its experimental status across multiple documentation files.

  • Removed docs/_snippets/csf-factories-codemod.md to discontinue automated migration support
  • Added "experimental" designation to CSF Factories in docs/api/portable-stories/portable-stories-vitest.mdx and portable-stories-jest.mdx
  • Added manual migration instructions for Vitest setup files in docs/api/csf/csf-factories.mdx
  • Fixed incorrect subpath imports snippet in package.json examples

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Feb 19, 2025
@kylegach kylegach self-assigned this Feb 19, 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.

LGTM

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

Copy link

nx-cloud bot commented Feb 19, 2025

View your CI Pipeline Execution ↗ for commit 9909bca.

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

☁️ Nx Cloud last updated this comment at 2025-02-20 16:04:40 UTC

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@kylegach, I appreciate your time putting together this pull request and polishing up the documentation. Appreciate it 🙏 ! I left some items for you to look into when you can. I'm approving to unblock you

@kylegach kylegach merged commit 0aa2e8c into next Feb 20, 2025
8 checks passed
@kylegach kylegach deleted the docs-csf-factories-fixes branch February 20, 2025 16:08
@github-actions github-actions bot mentioned this pull request Feb 21, 2025
11 tasks
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.

2 participants