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

Investigate Starlight Details component #50

Open
1 of 6 tasks
melissahenderson opened this issue Sep 17, 2024 · 1 comment
Open
1 of 6 tasks

Investigate Starlight Details component #50

melissahenderson opened this issue Sep 17, 2024 · 1 comment
Assignees
Labels
priority: low Issue is a low priority user-docs

Comments

@melissahenderson
Copy link
Contributor

melissahenderson commented Sep 17, 2024

When we first moved to Starlight, it didn't have a native component that allowed us to hide-collapse/show-expand content, so HJ created the Disclosure component for us.

Starlight now has a native Details component that conceptually works the same way. Edit: FYI for us all, Details is not a Starlight component, but rather standard HTML

We need to compare the two and if they are the same, or similar enough, then we should use the native Starlight component.

For this issue to be complete:

  • Compare the two components. If the home-grown component is better, then that's all we need to do. Otherwise...
  • Identify all doc pages in all projects that use our Disclosure component. I don't think there's too many. One example is the Rafiki Webhooks page.
  • Update those pages to use the Details HTML.
  • Create an issue in the docs-design-system repo letting Sarah know we don't need the Disclosure component anymore.
  • Assign issue to Sarah.
  • Update our style guide by deleting the /shared/disclosure/ page.
@hajjimo hajjimo self-assigned this Sep 23, 2024
@melissahenderson melissahenderson added the priority: low Issue is a low priority label Sep 30, 2024
@melissahenderson
Copy link
Contributor Author

During our team meeting today, we decided to use the native Starlight component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low Issue is a low priority user-docs
Projects
Status: In Progress
Development

No branches or pull requests

2 participants