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.

Sign up for GitHub

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

Jump to bottom

Fix Storybook code snippets #1078

Closed
3 tasks done
larsrickert opened this issue May 14, 2024 · 0 comments
Closed
3 tasks done

Fix Storybook code snippets #1078

larsrickert opened this issue May 14, 2024 · 0 comments
Assignees
@larsrickert
Labels
bug Something isn't working or not shown correctly dev Requires technical expertise
Milestone
Documentation

Comments

@larsrickert
Copy link
Collaborator

larsrickert commented May 14, 2024 •
edited by MajaZarkova
Loading

Many code snippets for components in Storybook are broken because we use the h() method from vue to render the slots or some icon properties are breaking the syntax.

Image

  • check all code snippets for component examples and fix them if they are broken
  • add review point to reference DEV ticket that requires manual review of the code snippets on the deployed Storybook

Approval
@larsrickert larsrickert added this to onyx May 14, 2024
@larsrickert larsrickert self-assigned this May 14, 2024
@larsrickert larsrickert converted this from a draft issue May 14, 2024
@larsrickert larsrickert added the bug Something isn't working or not shown correctly label May 14, 2024
This was referenced May 14, 2024
Closed
Merged
@mj-hof mj-hof added the dev Requires technical expertise label May 22, 2024
larsrickert added a commit that referenced this issue May 23, 2024
@larsrickert
fix: improve Storybook code snippets (#1134)
99b2089 
Relates to #1078, #414

- simplified some Stories
- refactor oynx icon import code transformer to work globally so we
don't need to add it to every component that uses icons
- temporarily copy over improved source code generation until it is
released in Storybook itself (see
storybookjs/storybook#27194)
@larsrickert larsrickert moved this from In Progress to In Approval in onyx May 24, 2024
@github-project-automation github-project-automation bot moved this from In Approval to Done in onyx May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@larsrickert larsrickert

Labels
bug Something isn't working or not shown correctly dev Requires technical expertise
Projects
onyx
Status: Done
Milestone
Documentation
Development

No branches or pull requests
2 participants
@larsrickert @mj-hof