Skip to content

Add guidelines on how to use components together #86

@rebeccaalpert

Description

@rebeccaalpert

The repo README does not clearly state the purpose of the extension or how the components can be used together. Similarly, we lack any sort of overview on the main PF website that shows how these components can be put together.

We should update/add these and make it clearer how these components can be used together and what they are for.

From Andrew Ballantyne:

I’m not sure what I am supposed to be able to glean from the docs on patternfly.org. The Repo README seems a bit lacking too… If I wanted to use this, how do I see what it is offering? Do we have a rendering/sandbox mode of it somewhere?

I guess I was looking for the “how it all works together” experience, and I can’t find one that shows me that. We were having a UX meeting and I was curious what the experience was like to have a catalog, and felt like this set of data very weirdly structured. I guess if I was familiar with the extension, these individual components would be helpful as any component documentation in PF docs are — looking at use-cases and props and what have you — but it seemed to be missing the “bigger picture” stuff. I guess an overview page/README would solve that in some degree

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions