Skip to content

Patternfly API docs - provide option to list all components alphabetically #4443

@mfrances17

Description

@mfrances17

Is this a new component or an extension of an existing one?
Extension

What is the existing component, if any?
Patternfly API documentation

Describe the feature
It would be nice to have an option in the docs to list all PF components alphabetically in the side bar. For example, TextArea and TextInput are buried under the Forms heading, and Select and Dropdown are under the Menus heading. While this may make sense from a design standpoint, it does not really reflect how many users typically use API documentation. They're used to searching first, but if given a list, they would expect to see it listed alphabetically and not have to make a connection to how it's typically used. Having an alphabetical list would remove this need for abstraction. I've had to hunt myself a few times.

I don't want to take away from the current organization, given it was probably done to provide some organization to a long list. I would suggest making it optional, such as a link that says something like 'List all alphabetically' or something of that sort, and when clicked it replaces the existing list. Bonus points for saving this as the default when reopened.

Are there visuals for this feature? If applicable, please include examples for each state and for varying widths
Would just be the exact same layout, but replace default list with an alphabetical list in the sidebar.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    Not started

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions