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

Stories cannot be documented #51

Open
ksiabani opened this issue Dec 23, 2021 · 0 comments
Open

Stories cannot be documented #51

ksiabani opened this issue Dec 23, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation needs analysis Further analysis is needed
Milestone

Comments

@ksiabani
Copy link
Collaborator

In Storybook 5 when we wanted to document a story we could use a JSDocs-style documentation before the component, like shown below:

/**
* A simple list. If `divider` is passed, items are separated by a border.
*/
export const SimpleList: ComponentStory<typeof List> = () => {
const menuItems = [
{ primary: 'Inbox' },
{ primary: 'Drafts' },
{ primary: 'Trash' },
];
return (
<div className="story__list">
<List divider items={menuItems} />
</div>
);
};

That will then be shown in the storybook page. With version 6 of Storybook this is not possible anymore.

@ksiabani ksiabani added documentation Improvements or additions to documentation needs analysis Further analysis is needed labels Dec 23, 2021
@ksiabani ksiabani added this to the Version 1.0 milestone Dec 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs analysis Further analysis is needed
Projects
None yet
Development

No branches or pull requests

1 participant