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

collapsible sections on component docs pages? #2523

Open
brian-smith-tcril opened this issue Aug 10, 2023 · 2 comments
Open

collapsible sections on component docs pages? #2523

brian-smith-tcril opened this issue Aug 10, 2023 · 2 comments
Labels
discovery Pre-work to determine if an idea is feasible documentation Relates to documentation improvements

Comments

@brian-smith-tcril
Copy link
Contributor

Inspired by this comment

As we add more examples to component pages on the docs site, it's possible users will feel overwhelmed with the amount of information presented at once.

It'd be great to ensure we don't overwhelm users, without scaling back the number of examples we provide for components.

One possible way to address this would be to add collapsible sections to the docs pages, so examples could be shown/hidden.

I'm sure there are other solutions to consider as well (hence marking this issue as "discovery")

@brian-smith-tcril brian-smith-tcril added documentation Relates to documentation improvements discovery Pre-work to determine if an idea is feasible labels Aug 10, 2023
@adamstankiewicz
Copy link
Member

Related, there has been some design discovery in the past to redesign the component pages on the documentation site: Figma.

For example, it splits out content into different tabs for "Design guidelines" vs. "Implementation" (but it could also have "Accessibility", etc.). That said, even then, the "Implementation" tab alone could be quite large given what we have today.

@brian-smith-tcril
Copy link
Contributor Author

Design guidelines and Implementation tabs would definitely go a long way!

One thing to consider is what we want to have above the fold on the implementation tab.

If the tabs go where they are in Figma at the moment
image

above the fold would stay the same between guidelines and implementation.

Another idea would be to split off the implementation examples into separate files. Possibly use cards to show/link to all the different examples that exist.

I'm just kind of throwing ideas around, I'm excited to see what design comes up with!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discovery Pre-work to determine if an idea is feasible documentation Relates to documentation improvements
Projects
None yet
Development

No branches or pull requests

2 participants