Skip to content

Implement storybook #222

Open
Open
@max-carroll

Description

@max-carroll

Feature Request

Describe the problem related to this feature request

We don't really have a decent way of various developing scenarios now without either
(1) Ensuring the docs contains an exhaustive number of use cases (although this perhaps constitutes abuse of the docs)
(2) Modifying the docs locally but then keeping a stash (not really Ideal)

Describe the solution you'd like

With story book we could have all the scenarios we need to check to ensure we havent broken anything without having to have exhaustive examples in the docs.

There's a few examples I added to the docs just as these are thing we would need to test each time we develop such as 20 Files etc.. but this is totally irrelevant for the docs perhaps

Describe alternatives you've considered

We could perhaps use an alternative to storybook, I suppose the main point is we have a way that we can quickly ensure things look right and behave correctly manually whilst developing. (Treating this exclusive from unit testing since we have an issue to deal with that seperately

Teachability, Documentation, Adoption, Migration Strategy

Perhaps we can update the readme and *.md files to include information about how to run the storybook (or selected soloutIon)

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsDocumentation related issues

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions