All components are documented and displayed on our main documentation website, which is rendered with Storybook.
There are two layers of documentation in Storybook:
The Storybook menu is structured accordingly. For example:
In this layer, the structure follows the UX definitions of the design system. It contains common examples and use cases, along with explanations of how and when to use the components. Additionally, it includes links to the actual component APIs in the next section.
To create a Storybook page for a component's story, you need to create a *.story.ts file in the component's folder:
MyComponent.story.ts
The documentation content of the component page (demo, description, do and don't lists, examples) lives next to the component as one MDX file, src/<ComponentName>/docs/<ComponentName>.mdx. Scaffold it with pnpm --filter @wix/design-system-documentation docs:new <ComponentName> and fill it in with the create-component-docs skill.
As developers, we are responsible for providing proper TypeScript (TS) and JSDoc comments for the component's API, which will be used to generate the API and Testkit tabs in the Storybook page.
Last updated: 26 October 2026