Skip to content

Storybook as repo documentation #147

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

Closed
erikyo opened this issue Jan 20, 2023 · 1 comment · Fixed by #148
Closed

Storybook as repo documentation #147

erikyo opened this issue Jan 20, 2023 · 1 comment · Fixed by #148
Assignees
Labels

Comments

@erikyo
Copy link
Collaborator

erikyo commented Jan 20, 2023

What problem does this address?

Actually we haven't a (easy to reach) user documentation

What is your proposed solution?

Using storybook we can create a little nicer documentation than the traditional one, and also we can show the components of the project and play with them. Using build-storybook -o docs/, should published and shown in the right panel of the Github repo home page

Here an example:
feature-notifications Storybook

@erikyo erikyo added the demo label Jan 20, 2023
@erikyo erikyo self-assigned this Jan 20, 2023
@Sephsekla
Copy link
Collaborator

When this is merged I'll look at disabling the repo wiki - a lot of this is out of date anyway and we don't want to be maintaining duplicate docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants