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: Explore replacing Storybook with CodeSandbox #446

Closed
hawkticehurst opened this issue Jan 10, 2023 · 1 comment · Fixed by #460
Closed

Docs: Explore replacing Storybook with CodeSandbox #446

hawkticehurst opened this issue Jan 10, 2023 · 1 comment · Fixed by #460
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@hawkticehurst
Copy link
Member

Feature request

While Storybook was originally used for both testing and documentation it is now exclusively used as a sort of interactive component sandbox that is used to augment our documentation.

Due to a recent PR, Storybook can no longer be built with no easy fix and the CD pipeline for deploying Storybook has been removed as a result.

This means the interactive components are still available but new releases cannot be made, and as time continues the docs are at risk of becoming out of date.

Since we only need a way to show interactive code samples, I believe using CodeSandbox could an easy/low effort alternative to Storybook (and notably clean up/simplify our codebase and dependencies quite a bit).

@hawkticehurst hawkticehurst added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 10, 2023
@hawkticehurst hawkticehurst self-assigned this Jan 10, 2023
@hawkticehurst
Copy link
Member Author

In the long term future it might also be worth exploring the usage of GitHub Blocks as it would mean our interactive and static docs could theoretically live side by side.

GitHub Blocks is only a technical exploration at this point, however, so we will have to wait and see if it is added to GitHub as a full feature.

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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant