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

[DSS-85] Storybook: improve consistency with component documentation #1614

Merged
merged 9 commits into from
Oct 6, 2022

Conversation

pixelflips
Copy link
Member

@pixelflips pixelflips commented Oct 4, 2022

Description

Updates documentation across Storybook pages in order to complete the following:

  • Updates parameters to “Show code” for each example by default
  • Add a description to the top of the component page that matches the Rails description of the component. (see description note below.)
  • Minor follow-up updates to display code examples that are returning <No Display Name />.

Description Note: For components with no descriptions, code has been added in preparation for an upcoming description refactor. This will allow for the dev to only concentrate on the copy updates.

Screenshots

Before After
Screen Shot 2022-10-04 at 2 37 02 PM Screen Shot 2022-10-04 at 2 37 43 PM

Testing in sage-lib

  • Navigate to Storybook
  • Navigate to any components.
  • Switch to the Docs tab.
  • Verify code displays by default.
  • Verify description displays where applicable. (see Description Note above.)

Testing in kajabi-products

  1. (LOW) Adds component descriptions and displays the code examples by default in Storybook. Documentation update only, no effect on KP expected.

Related

https://kajabi.atlassian.net/browse/DSS-85

@pixelflips pixelflips added documentation Improvements or additions to documentation improvement Improve on existing work labels Oct 4, 2022
@pixelflips pixelflips self-assigned this Oct 4, 2022
@pixelflips pixelflips force-pushed the DSS-85_pl-improve-consistency-storybook branch from 0c83a7c to 9675814 Compare October 5, 2022 15:31
@pixelflips pixelflips marked this pull request as ready for review October 5, 2022 19:12
@pixelflips pixelflips requested a review from a team October 5, 2022 19:12
Copy link
Contributor

@philschanely philschanely left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fabulous additions and updates here.

@pixelflips pixelflips force-pushed the DSS-85_pl-improve-consistency-storybook branch from 9675814 to d6e31cd Compare October 6, 2022 15:42
@pixelflips pixelflips requested a review from a team October 6, 2022 15:43
@ju-Skinner ju-Skinner requested a review from a team October 6, 2022 19:58
@pixelflips pixelflips merged commit fc2d7e4 into develop Oct 6, 2022
@pixelflips pixelflips deleted the DSS-85_pl-improve-consistency-storybook branch October 6, 2022 21:05
@pixelflips pixelflips mentioned this pull request Oct 6, 2022
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 improvement Improve on existing work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants