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

Implement component tagging system #27

Open
elainen opened this issue Apr 22, 2019 · 0 comments
Open

Implement component tagging system #27

elainen opened this issue Apr 22, 2019 · 0 comments

Comments

@elainen
Copy link
Contributor

elainen commented Apr 22, 2019

Is your feature request related to a problem? Please describe.

We'll need to find a way for people to easily search through components based on their current stack (looking for a component that uses styled-components for styling, or looking for a react-slick carousel instead of a nuka-carousel)

Describe the solution you'd like

Create a tagging system where each component will have a set of tags based on the component's implementation.
For example, a fade to view component can have #react-string, #styled-components. These tags can probably be manually added, as well as auto-generated based on their own package.json.

Describe alternatives you've considered

We've considered with just sticking to the current organization of Headless Components, Hooks, Styled Components, Utilities as shown in the site right now but may get confusing as certain components might start having overlapping features. I would think we would still have this kind of a structure on the sidebar for starters but will also have this tagging system as an extra layer on top to provide a better component discovery process.

Additional context

Overview of possible implementation features:

  • Use of keywords field in package.json as manual addition to tags
  • Auto generate basic tags from listed common packages in package.json
  • Probably wouldn't need to hijack the docz search functionality too much if we can just push out the keywords into the markdown.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant