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

chore(stories): add categories #4154

Merged
merged 6 commits into from Oct 7, 2019
Merged

Conversation

francoischalifour
Copy link
Member

@francoischalifour francoischalifour commented Oct 1, 2019

Description

This adds sections in our Storybook following the same organization as the documentation API ref.

Note that this updates the stories URLs and therefore we need to update the documentation links for v4.

Let me know if you want to go that route so that I PR the doc repo.

Preview

See stories →

@francoischalifour francoischalifour requested a review from a team October 1, 2019 09:11
@ghost ghost requested review from eunjae-lee and tkrugg and removed request for a team October 1, 2019 09:11
Copy link
Contributor

@samouss samouss left a comment

Choose a reason for hiding this comment

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

If we move forward with this, we should keep the same order than the doc.

  • Basics
  • Results
  • Refinements
  • Pagination
  • Metadata
  • Sorting

@francoischalifour
Copy link
Member Author

@samouss Do you have an easy solution in mind? Storybook's documentation isn't clear about sorting categories of stories.

@Haroenv
Copy link
Contributor

Haroenv commented Oct 1, 2019

already upvoted this once apparently but: storybookjs/storybook#548 (comment)

@Haroenv
Copy link
Contributor

Haroenv commented Oct 1, 2019

there's also storybookjs/storybook#548 (comment)

@francoischalifour
Copy link
Member Author

Thanks @Haroenv! See 2d03a57.

@francoischalifour
Copy link
Member Author

Typing issues on Storybook's end... Let's wait for storybookjs/storybook#8233 to be fixed.

.storybook/config.ts Outdated Show resolved Hide resolved
@Haroenv
Copy link
Contributor

Haroenv commented Oct 1, 2019

@Haroenv
Copy link
Contributor

Haroenv commented Oct 1, 2019

we can add @types/webpack-env as a dev dep, or skipLibCheck: true

@francoischalifour
Copy link
Member Author

Upgrading to Storybook 5.2.3 fixed the issue.

Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

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

looks good, but we need the PR to update the docs ready to be merged before this is merged, right?

@francoischalifour
Copy link
Member Author

@Haroenv PR sent in algolia/doc#3807. I'm also updating the PR for the new index widget.

@francoischalifour
Copy link
Member Author

The order of the sections changed in the doc in the meantime ahah. I'll reflect the order in this PR.

@francoischalifour francoischalifour merged commit bdc84e9 into next Oct 7, 2019
@francoischalifour francoischalifour deleted the chore/stories-categories branch October 7, 2019 14:41
Haroenv pushed a commit that referenced this pull request Oct 23, 2019
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

Successfully merging this pull request may close these issues.

None yet

3 participants