Merge pull request #27132 from storybookjs/misc-docs-updates

Docs: Misc 8.1 updates
storybookjs · May 15, 2024 · 3974106 · 3974106
2 parents db078a6 + b85c91f
commit 3974106
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/code/addons/docs/docs/docspage.md b/code/addons/docs/docs/docspage.md
@@ -166,9 +166,9 @@ You can override this default behavior in `.storybook/preview.js` (or in any of
 export const parameters = {
   docs: {
     canvas: {
-      sourceState: 'shown'
-    }
-  }
+      sourceState: 'shown',
+    },
+  },
 };
 ```
 

diff --git a/docs/api/portable-stories-playwright.md b/docs/api/portable-stories-playwright.md
@@ -1,5 +1,5 @@
 ---
-title: 'Portable stories in Playwright'
+title: 'Portable stories in Playwright CT'
 ---
 
 export const SUPPORTED_RENDERERS = ['react', 'vue'];
@@ -34,6 +34,8 @@ Normally, Storybook composes a story and its [annotations](#annotations) automat
 
 <Callout variant="warning">
 
+Your project must be using React 18+ to use the portable stories API with Playwright CT.
+
 **Using `Next.js`?** The portable stories API is not yet supported in Next.js with Playwright CT.
 
 <!-- **Using `Next.js`?** Next.js requires specific configuration that is only available in [Jest](./portable-stories-jest.md). The portable stories API is not supported in Next.js with Playwright CT. -->

diff --git a/docs/api/story-pipeline-playwright-ct.png b/docs/api/story-pipeline-playwright-ct.png
diff --git a/docs/api/story-pipeline.png b/docs/api/story-pipeline.png
diff --git a/docs/writing-stories/mocking-modules.md b/docs/writing-stories/mocking-modules.md
@@ -95,6 +95,16 @@ import { getUserFromSession } from '#lib/session';
 // ... rest of the file
 ```
 
+<Callout variant="info">
+
+Subpath imports will only be correctly resolved and typed when the [`moduleResolution` property](https://www.typescriptlang.org/tsconfig/#moduleResolution) is set to `'Bundler'`, `'NodeNext'`, or `'Node16'` in your TypeScript configuration.
+
+If you are currently using `'node'`, that is intended for projects using a Node.js version older than v10. Projects written with modern code likely do not need to use `'node'`.
+
+Storybook recommends the [TSConfig Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet) for guidance on setting up your TypeScript configuration.
+
+</Callout>
+
 ## Builder aliases
 
 If your project is unable to use [subpath imports](#subpath-imports), you can configure your Storybook builder to alias the module to the mock file. This will instruct the builder to replace the module with the mock file when bundling your Storybook stories.