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

Publicize undocumented components #107

Open
rezrah opened this issue Oct 20, 2022 · 0 comments
Open

Publicize undocumented components #107

rezrah opened this issue Oct 20, 2022 · 0 comments
Labels

Comments

@rezrah
Copy link
Collaborator

rezrah commented Oct 20, 2022

primer.style/brand documentation currently shows a handful of cherry-picked UI patterns, rather than the entire inventory of components available through the npm package.

List of undocumented components at time of issue creation:

  • Button
  • InlineLink
  • Accordion
  • Link
  • ThemeProvider (merged into theming, but could benefit from separate docs for the React component API)
  • ExpandableArrow
  • hooks
    • useKeyboardEscape
    • useOnClickOutside
    • useIsomorphicEffect
  • Page layout examples
    • Kitchen sink

Proposal

  • Review components listed above and decide which ones (if any) warrant separate doc pages.
  • Publish new doc pages

Why do this?

  • Increase adoption of Primer Brand library by accurately documenting existing inventory.
  • Storybook is being used as a source of truth and shopfront right now as docs examples are sparse.

Questions

  • Should hooks be documented?
  • Categorisation of components and impact on discoverability.. should Buttons and InlineLink go under Call to Actions or Components?
@rezrah rezrah added the brand label Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant