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

Improve component discoverability on website by switching to single-page docs #314

Open
jilliankeenan opened this issue Oct 1, 2020 · 0 comments
Labels
enhancement New feature or request hacktoberfest

Comments

@jilliankeenan
Copy link
Contributor

Problem
The current search/filter bar in puppet.style only filters by component name. The issue here is discoverability when a developer might be searching for a "dropdown" when the design system names it a "select" for example.

Solution
Go back to a single-page scrolling Storybook implementation instead of breaking each component out into a separate page so the developer can ctrl-f to do a full-text search. Single-page is the Styleguidist default so we should be able to just switch that config setting back.

Do a pass on the docs and make sure common synonyms for component appear in the text, e.g. make sure the word "dropdown" is included in each of the three *Select components.

@jilliankeenan jilliankeenan added enhancement New feature or request hacktoberfest labels Oct 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant