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

Document potential ways to show pattern code (Storybook, website, sandboxes) #6489

Open
3 tasks
Tracked by #5041
elycheea opened this issue Nov 20, 2024 · 1 comment
Open
3 tasks
Tracked by #5041
Assignees
Labels
role: dev type: docs 📖 Improvements or additions to documentation type: process 🎞️ Process and other project mgmt tasks or discussions type: stories 📚 Updates to Storybook examples or docs

Comments

@elycheea
Copy link
Contributor

elycheea commented Nov 20, 2024

Problem

As we begin deprecation of specific patterns, we need to decide where to actually publish and maintain the pattern example code.

Possible solutions

  • Expand section in our Storybook examples gallery
  • Publish code snippets to website
  • Separate repositories for larger example workstreams

Acceptance criteria

  • Evaluate potential options (including others that may not be listed) and list out pros and cons of each approach
  • Prototype the solutions
  • Playback to the design + dev team to determine best path forward
@github-project-automation github-project-automation bot moved this to Needs triage 🧐 in Carbon for IBM Products Nov 20, 2024
@elycheea elycheea added type: docs 📖 Improvements or additions to documentation type: process 🎞️ Process and other project mgmt tasks or discussions type: stories 📚 Updates to Storybook examples or docs role: dev and removed status: needs triage 🕵️‍♀️ labels Nov 20, 2024
@elycheea elycheea moved this from Needs triage 🧐 to Backlog 🌋 in Carbon for IBM Products Nov 20, 2024
@matthewgallo
Copy link
Member

I've seen a pattern across other libraries of showing patterns inline from the docs/website, and often times this is done via an iframe from a storybook. Just brainstorming here, but we could have a pattern only storybook so we can keep a distinction between these patterns and our currently supported components from @carbon/ibm-products and @carbon/ibm-products-web-components. And that new storybook would be used to display the patterns on the website, along with relevant example code snippets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: dev type: docs 📖 Improvements or additions to documentation type: process 🎞️ Process and other project mgmt tasks or discussions type: stories 📚 Updates to Storybook examples or docs
Projects
Status: Backlog 🌋
Development

No branches or pull requests

2 participants