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

Storybook "Show Info" button should not interfere with the stories themselves #183

Closed
hokei opened this issue May 28, 2020 · 5 comments
Closed

Comments

@hokei
Copy link
Collaborator

hokei commented May 28, 2020

Description of issue:

Currently, Storybook's "More Info" button sits on top of the component
Screen Shot 2020-05-28 at 10 11 37 AM

This can obscure bugs that we don't catch until later
Screen Shot 2020-05-28 at 10 12 09 AM

@hokei hokei added this to the Story Cleanup milestone May 28, 2020
@M0nica M0nica self-assigned this May 28, 2020
@helenvholmes
Copy link
Contributor

Hm, that "+" icon is looking mighty funky too 🤔

@hokei
Copy link
Collaborator Author

hokei commented May 29, 2020

that's fixed in #185, the funkiness what made the info button clearly an issue haha

@M0nica M0nica removed their assignment May 29, 2020
@M0nica
Copy link
Contributor

M0nica commented May 29, 2020

I'm not sure yet when I can work on this story so I unassigned myself for now in-case anyone else wants to pick up. I started looking into it a bit and saw some GitHub issues (storybookjs/storybook#1147 (comment)) that suggested that the addon-docs https://www.npmjs.com/package/@storybook/addon-docs was created to replace the info addon.

Based on what I've seen so far I'd recommend considering replacing the info addon with the addon docs as the info addon seems to have limited ability to customize positioning. I believee additional configuration needs to be done after the initial setup to ensure that the addon docs can automatically parse the TypeScript types for each story.

@helenvholmes
Copy link
Contributor

@M0nica that's a good suggestion, and makes a lot of sense. I think for the documentation add-on we might want to pull in the content for it from Airtable, which powers Metronome (which in turn adds a layer of complication). I don't think it's a hardcore to-do for this sprint.

@helenvholmes
Copy link
Contributor

Captured removing the info button in #144, so closing this out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants