docs: Add Storybook documentation landing page #334
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docz is not supported anymore. We decided to migrate to a stable solution Co-authored-by: Zack Jones <[email protected]> Co-authored-by: Nikolai Lopin <[email protected]> docs: migrate components to storybook part 1 (#313) Components migrated: * Accordion * Banner * Box * Card WECH-23: Migrate components to storybook part 2 (#314) * Checkbox * Datepicker * Dimmer * Divider * Filepicker --------- Co-authored-by: Zack Jones <[email protected]> Co-authored-by: Cristian Sanchez <[email protected]> Co-authored-by: Nikolai Lopin <[email protected]> docs: migrate components to storybook * docs: add input story * docs: add label story * docs: add link story * docs: add modal story * docs: add offcanvas story * docs: define argTypes for Input and Label stories * docs(password): add Password to Storybook * docs(phoneinput): add PhoneInput to Storybook * fix(test): update snapshots * docs(pagination): add Pagination to Storybook * docs(radiobutton): add RadioButton to Storybook * docs(popover): add Popover to Storybook --------- Co-authored-by: Aleksandar Spasov <[email protected]> Co-authored-by: Ján Hamara <[email protected]> migrate to storybook v7 (#323) chore: fix failing storybook Update typescript to the lowest supported version docs: migrate component pages to storybook (#316) * Input * Label * Link * Modal * Offcanvas Co-authored-by: Aleksandar Spasov <[email protected]> Co-authored-by: Nikolai Lopin <[email protected]> docs: migrate components to storybook (#317) * table * tag * text * textarea * toggle * tooltip --------- Co-authored-by: Christian <[email protected]> Co-authored-by: Nikolai Lopin <[email protected]> docs: migrate components (#320) * Search * TabBar * Select * SelectList * Skeleton Co-authored-by: Inga Schünemann <[email protected]> docs: migrate essentials to storybook (#322) * essentials pages * Logo * Icons * remove IE 11 from the list of supported --------- Co-authored-by: lena <[email protected]> Co-authored-by: Vanessa Knibbe <[email protected]> Co-authored-by: Nikolai Lopin <[email protected]> docs: migrate Grid docs ci: install with legacy in docs pipeline docs: migrate Headline docs docs: migrate HelperText docs: migrate InlineSpinner docs: migrate Infobanner docs docs: remove unused code docs: move accordion stories to the accordion folder docs: move Box stories to the box folder docs: move Button stories to the button folder docs: moves Card stories to the card folder docs: moves Checkbox stories to the checkbox folder docs: moves Banner stories to the banner folder docs: moves Dimming stories to the dimming folder docs: moves Divider stories to the divider folder docs: moves datepicker stories to the datepicker folder docs: clean banner docs docs: use new imports docs: remove stories folder docs: migrate Table docs to csf3 docs: migrate Input docs to csf3 docs: migrate Popover docs to csf3 docs: migrate Label docs to csf3 docs: migrate Link docs to csf3 docs: migrate Tag docs to csf3 docs: migrate Modal docs to csf3 docs: migrate Tooltip docs to csf3 docs: migrate Toggle docs to csf3 docs: migrate Textarea docs to csf3 docs: migrate Text docs to csf3 docs: show Text default values docs: migrate Password docs to csf3 docs: migrate TabBar docs to csf3 docs: migrate RadioButton docs to csf3 docs: migrate PhoneInput docs to csf3 docs: migrate Offcanvas docs to csf3 docs: migrate FilePicker docs to csf3 docs: migrate Skeleton docs to csf3 docs: migrate Select docs to csf3 docs: align naming of doc pages docs: migrate SelectList docs to csf3 docs: migrate Pagination docs to csf3 docs: use ArgTypes for table ArgsTable is deprecated docs: use consistent stories import docs: polish docs docs: use helper for dark background
…tech/wave into WECH-35/bring-storybook-migration-to-main
JanHamara
requested review from
nlopin,
martimalek,
div-Leo and
jonotrujillo
as code owners
nlopin
suggested changes
May 22, 2023
There was a problem hiding this comment.
Great work Jan! It looks awesome 🏄♂️
I've mentioned some issues in the review, the main things are freenow font and index.storybook.mdx. The index file has custom layout and we cannot avoid it. At the same time, we can try to reduce the markup so the text is easy to edit when needed. I've suggested the unstyled component, it could shave off some divs
jonotrujillo
approved these changes
May 22, 2023
div-Leo
approved these changes
May 22, 2023
martimalek
approved these changes
May 22, 2023
2 tasks
JanHamara
added a commit
that referenced
this pull request
May 25, 2023
Fix up default font for theme to Open Sans (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
JanHamara
added a commit
that referenced
this pull request
May 25, 2023
Update 'by Freenow' SVG with one with correct font (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
nlopin
pushed a commit
that referenced
this pull request
May 26, 2023
* feat(landing): add landing page for Storybook * docs(landing): finish the landing page integration * docs(theme): theme storybook with our branding * refactor(landingpage): mr review modifs part 1 * refactor(landing): wrap landing page mdx in unstyled component --------- Co-authored-by: Ján Hamara <[email protected]>
nlopin
pushed a commit
that referenced
this pull request
May 26, 2023
Fix up default font for theme to Open Sans (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
nlopin
pushed a commit
that referenced
this pull request
May 26, 2023
Update 'by Freenow' SVG with one with correct font (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
martimalek
pushed a commit
that referenced
this pull request
May 26, 2023
* feat(landing): add landing page for Storybook * docs(landing): finish the landing page integration * docs(theme): theme storybook with our branding * refactor(landingpage): mr review modifs part 1 * refactor(landing): wrap landing page mdx in unstyled component --------- Co-authored-by: Ján Hamara <[email protected]>
martimalek
pushed a commit
that referenced
this pull request
May 26, 2023
Fix up default font for theme to Open Sans (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
martimalek
pushed a commit
that referenced
this pull request
May 26, 2023
Update 'by Freenow' SVG with one with correct font (my bad, I left behind one commit and merged in the MR before pushing it) Relevant MR: #334
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What:
Adds main landing page for the Storybook navigation (includes navigation to some of the most essential parts of the new documentation in SB)
Why:
We've put quite a lot of effort into migrating our old docs into Storybook.
While Storybook is a great tool for documentation, isolated-development, testing of components, etc. many top companies worldwide and their design systems use a combination of Storybook and a separate documentation website (that links to Storybook, Figma, repository source code, and more) to fulfil their documentation purposes.
That could include:
Some examples:
Anyways, we don't currently have available time and effort to develop such sophisticated documentation website, but this MR should be sort of an indicator of effort to integrate a bit of a more visual documentation and better look into our Storybook, on which we can develop later.
How:
Media:
Checklist: