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

docs: Made storybook docs available again, small org changes elsewhere #2795

Merged
merged 11 commits into from Mar 6, 2024

Conversation

werdnanoslen
Copy link
Member

@werdnanoslen werdnanoslen commented Mar 4, 2024

Summary

The latest update to storybook saw a "feature" moving docs from a consistent tab to a new page for each component. The main change here changes .storybook/main.ts to make that available for all pages and modifies the global storybook[-docs] params to use the right fonts. However, we don't want the docs treatment for the welcome page, so I refactored that as a .mdx file, so now that appears as it did before with the benefit it being much simpler markdown file. This also required the Templates folder to be flattened, as the sub-folder Authentication Pages could only have one docs page.

I also moved the Link out of its lonely Typography folder and the TimePicker out of its deprecated form controls folder

Related Issues or PRs

None

How To Test

Check that all components and template pages have the same docs as before, just in a page instead of a tab

Screenshots (optional)

image

@werdnanoslen werdnanoslen requested a review from a team as a code owner March 4, 2024 23:19
Copy link
Contributor

github-actions bot commented Mar 4, 2024

Warnings
⚠️ This PR does not include changes to tests, even though it affects source code.

Generated by 🚫 dangerJS against e27a5e1

@werdnanoslen werdnanoslen requested a review from a team March 4, 2024 23:27
AnnaGingle
AnnaGingle previously approved these changes Mar 5, 2024
Copy link

@AnnaGingle AnnaGingle 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 to me!

Copy link
Contributor

@gidjin gidjin left a comment

Choose a reason for hiding this comment

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

LGTM

@werdnanoslen werdnanoslen merged commit e77fe30 into main Mar 6, 2024
7 checks passed
@werdnanoslen werdnanoslen deleted the an-storybookdocs branch March 6, 2024 05:18
@sawyerh
Copy link
Contributor

sawyerh commented Mar 21, 2024

@werdnanoslen Hey there, did this go live? I'm not seeing the Docs on components like Textarea:

CleanShot 2024-03-21 at 10 05 00@2x

@werdnanoslen
Copy link
Member Author

@sawyerh It did, but then our Github Actions broke 🙃 . We're working that out now in #2843

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.

[docs] Not possible to see the React code of stories
4 participants