Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

add storybook link and adjust CONTRIBUTING.MD #492

Conversation

MaxKless
Copy link
Contributor

@MaxKless MaxKless commented Jun 19, 2023

The storybook is a great resource for the toolkit but it's not linked anywhere in the repo.

Also, some of the scripts listed in CONTRIBUTING.MD don't exist anymore.

@MaxKless MaxKless marked this pull request as draft June 19, 2023 10:20
@MaxKless MaxKless changed the title Codespace maxkless refactored fiesta 7r7qwrwx56gcq66 add storybook link and adjust CONTRIBUTING.MD Jun 19, 2023
@MaxKless MaxKless force-pushed the codespace-maxkless-refactored-fiesta-7r7qwrwx56gcq66 branch from 0e91727 to ac0f754 Compare June 19, 2023 10:25
@MaxKless
Copy link
Contributor Author

@microsoft-github-policy-service agree company="Nx"

@MaxKless MaxKless marked this pull request as ready for review June 19, 2023 10:27
@hawkticehurst
Copy link
Member

Hey @MaxKless, thanks for the PR!

Removing links to Storybook was actually an intentional change because our Storybook build pipeline broke with no easy fix awhile ago.

As a result, we switched all our documentation samples to use CodeSandbox and those now operate as the official and most up-to-date version of interactive code snippets/samples.

I left the Storybook published for posterity purposes. But without an ability to denote that the docs are deprecated (since we can't build/publish new versions) I realize we should probably just remove it –– especially if people are still able to find the docs like you did.

Hope that all makes sense and let me know if you have any questions! :)

@hawkticehurst
Copy link
Member

With all that said, thank you for the catch on the contributing docs mismatch! If you want to adjust this PR so the only change is removing the npm run build:docs line entirely I'd be happy to accept and merge that

@MaxKless MaxKless force-pushed the codespace-maxkless-refactored-fiesta-7r7qwrwx56gcq66 branch from ac0f754 to 509d53c Compare June 21, 2023 11:44
@MaxKless
Copy link
Contributor Author

Ah that's good to know! I guess I will stop using it then :P
Thanks for taking the time and explaining the situation, I appreciate it.

Updated the PR.

@hawkticehurst
Copy link
Member

Ah that's good to know! I guess I will stop using it then :P Thanks for taking the time and explaining the situation, I appreciate it.

Updated the PR.

Of course, happy to do so! And thank you for updating, I'll give a quick review now

CONTRIBUTING.md Outdated Show resolved Hide resolved
@MaxKless MaxKless force-pushed the codespace-maxkless-refactored-fiesta-7r7qwrwx56gcq66 branch from 509d53c to 4ac8b3b Compare June 22, 2023 08:25
Copy link
Member

@hawkticehurst hawkticehurst left a comment

Choose a reason for hiding this comment

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

Perfect, thank you so much! :)

@hawkticehurst hawkticehurst merged commit 84fb97f into microsoft:main Jun 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants