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

[docs-infra] Create a feature list/highlights component #41479

Closed
danilo-leal opened this issue Mar 13, 2024 · 0 comments · Fixed by #41484
Closed

[docs-infra] Create a feature list/highlights component #41479

danilo-leal opened this issue Mar 13, 2024 · 0 comments · Fixed by #41484
Assignees
Labels
design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product

Comments

@danilo-leal
Copy link
Contributor

danilo-leal commented Mar 13, 2024

Summary

Primarily inspired by the Radix documentation, having a quick-to-skim feature list at the beginning of every component page is a fast way to communicate the main relevant features it supports in a summarized way. We already do this in a couple of places throughout all of the products:

But we don't have a standardized Markdown way to do it. What I mean by this is potentially a custom component that would render the list with a specific design instead of a plain bullet list with emojis. Radix created a Highlights component that we can be inspired by:

<Highlights
  features={[
    'Automatic and manual control over when the image renders.',
    'Fallback part accepts any children.',
    'Optionally delay fallback rendering to avoid content flashing.',
  ]}
/>

Search keywords: feature list, highlights

@danilo-leal danilo-leal added design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product labels Mar 13, 2024
@danilo-leal danilo-leal self-assigned this Mar 13, 2024
@danilo-leal danilo-leal changed the title [docs-infra] Standardize the "feature-list" design [docs-infra] Create a feature list/highlights component Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant