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

[Project - Onboarding]: Implement flow: "How to write your first Story" #22891

Closed
Tracked by #22558
valentinpalkovic opened this issue Jun 2, 2023 · 0 comments · Fixed by storybookjs/addon-onboarding#33
Assignees

Comments

@valentinpalkovic
Copy link
Contributor

valentinpalkovic commented Jun 2, 2023

Description

The goal of this task is to guide new users in writing their first Component Story Format (CSF) file in Storybook. After the user completes the initial step-by-step guide, a modal will appear, explaining the structure of a CSF file including the meta field, story exports, etc. In the final step, the user will be asked to copy a story and paste it into the button Story. Upon successful recognition of the new story, a "continue" button will lead the user to the new story, accompanied by a confetti rain animation to celebrate their achievement.

Acceptance Criteria:

  • After the first step-by-step guide is completed, a modal should appear, explaining how to create a CSF file, its structure, and its main components. It will explain the import, meta, stories and args part of a typical CSF file.
  • The modal should guide the user to copy a story and paste it into the button Story.
  • The system should correctly recognize the new story.
  • A "Go to Story" button should appear upon successful recognition of the new story, which will lead the user to the new story.
  • Upon navigating to the new story via the "Go to Story" button, a confetti rain animation should be triggered.
  • All existing features and functionalities should remain unaffected.

(To be discussed) Edge Cases to Consider:

  • Incorrect CSF file structure: If the user does not correctly follow the CSF file structure, the system should provide a meaningful error message and guide the user to correct it.
  • Failure to recognize the new story: The system should handle scenarios where it fails to recognize the new story, providing helpful error messages to guide the user.
  • Navigation and animation triggers: Ensure the "Go to Story" button and the confetti rain animation trigger correctly and at the appropriate times.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant