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

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

Open
mfrances17 opened this issue Jan 10, 2025 · 0 comments
Open

Comments

@mfrances17
Copy link
Contributor

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.

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

No branches or pull requests

1 participant