Skip to content

Commit e1bc98f

Browse files
Copilotd10c
andcommitted
Fix Overview.mdx for Storybook 10 compatibility
Removed deprecated imports from @storybook/addon-docs/blocks and converted to plain MDX with frontmatter. Added @storybook/addon-docs package which was missing. The Overview page now loads correctly without errors. Co-authored-by: d10c <9970661+d10c@users.noreply.github.com>
1 parent 849f2a4 commit e1bc98f

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

extensions/ql-vscode/src/stories/Overview.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
import { Canvas, Meta, Story } from '@storybook/addon-docs/blocks';
2-
31
import iframeImage from './images/update-css-variables-iframe.png';
42
import stylesImage from './images/update-css-variables-styles.png';
53
import bodyImage from './images/update-css-variables-body.png';
64

7-
<Meta title="Overview" />
5+
# Overview
86

97
Welcome to the Storybook for **CodeQL for Visual Studio Code**! This Storybook contains stories for components and pages in the extension.
108

11-
### Switching themes
9+
## Switching themes
1210

1311
To switch between VSCode Dark+ and Light+ themes, use the button in the toolbar. This will not work on this document, so you'll only see
1412
the changes applied to a different story.
1513

16-
### Writing stories
14+
## Writing stories
1715

1816
To create new stories, copy an existing story in the `src/stories` directory and modify it to use your component or page. Please note that
1917
you are not able to access any VSCode specific APIs or receive messages from VSCode so an ideal component would use generic props. The
@@ -25,12 +23,12 @@ is currently not possible to preview your component in another theme.
2523
For more information about how to write stories and how to add controls, please see the
2624
[Storybook documentation](https://storybook.js.org/docs/react/writing-stories/introduction).
2725

28-
### WebView UI Toolkit
26+
## WebView UI Toolkit
2927

3028
As much as possible, we try to make use of the [WebView UI Toolkit](https://github.com/microsoft/vscode-webview-ui-toolkit): See the
3129
[WebView UI Toolkit Storybook here](https://microsoft.github.io/vscode-webview-ui-toolkit/).
3230

33-
### Updating VSCode CSS variables
31+
## Updating VSCode CSS variables
3432

3533
The VSCode CSS variables that are injected into the Storybook preview are defined in the `src/stories/vscode-theme-dark.css` file. They need to be
3634
updated manually if new variables are added to VSCode. It can also be updated if you would like to manually preview a different theme. To update

0 commit comments

Comments
 (0)