From 85b2651a54090fe137da2b8d4dd0a1a4862d89a8 Mon Sep 17 00:00:00 2001 From: Anna Wen <54281166+annawen1@users.noreply.github.com> Date: Wed, 8 Jan 2025 10:48:12 -0500 Subject: [PATCH] feat: add how to contribute link to welcome page (#360) * feat: add how to contribute link to welcome page * chore: separate packages in README * chore: add image to README * chore: add links for WC and React storybooks * chore: format --- .storybook/welcome/Welcome.jsx | 6 ++++++ .storybook/welcome/welcome.scss | 4 ++++ README.md | 37 ++++++++++++++++++++++++++++----- 3 files changed, 42 insertions(+), 5 deletions(-) diff --git a/.storybook/welcome/Welcome.jsx b/.storybook/welcome/Welcome.jsx index 60b5dbac..13db5327 100644 --- a/.storybook/welcome/Welcome.jsx +++ b/.storybook/welcome/Welcome.jsx @@ -14,6 +14,12 @@ export const Welcome = () => { renderIcon={ArrowRight}> GitHub repo + + How to contribute + + + Carbon Design System + +

+

+ Carbon Labs +

> A community-organized incubation space for IBMers, housing assets in the > Discovery phase where research, exploration, and validation happen. @@ -8,15 +15,35 @@ This monorepo houses a collection of components, each as their own package. Here's a full list of packages that we support! +### React + +| Package name | Description | +| ------------------------ | ----------- | +| Ready for contributions! | | + +### Web Components + +| Package name | Description | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| [`@carbon-labs/ai-chat`](https://github.com/carbon-design-system/carbon-labs/tree/main/packages/web-components/src/components/chat) | AI Chat component | +| [`@carbon-labs/ai-tag`](https://github.com/carbon-design-system/carbon-labs/tree/main/packages/web-components/src/components/tag) | AI Tag component | + +### Shared + | Package name | Description | | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | -| [`@carbon-labs/ai-chat`](https://github.com/carbon-design-system/carbon-labs/tree/main/packages/chat) | AI Chat component | | [`@carbon-labs/utilities`](https://github.com/carbon-design-system/carbon-labs/tree/main/packages/utilities) | Common utilities shared amongst packages | -A Storybook demo of all component packages is available here: +## Storybook demos + +Storybook demo of all component packages available here: +https://labs.carbondesignsystem.com + +Storybook demos for the specific Web Component and React packages can be viewed +as well: -- Web Components Storybook: https://labs.carbondesignsystem.com/web-components -- React Storybook: https://labs.carbondesignsystem.com/react +- Web Components: https://labs.carbondesignsystem.com/web-components/ +- React: https://labs.carbondesignsystem.com/react/ ## 🙌 Contributing