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
carbon-design-system · Jan 8, 2025 · 85b2651 · 85b2651
1 parent b8c3cce
commit 85b2651
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 5 deletions.
diff --git a/.storybook/welcome/Welcome.jsx b/.storybook/welcome/Welcome.jsx
@@ -14,6 +14,12 @@ export const Welcome = () => {
             renderIcon={ArrowRight}>
             GitHub repo
           </Link>
+          <Link
+            href="https://github.com/carbon-design-system/carbon-labs?tab=readme-ov-file#-contributing"
+            className="welcome__link"
+            renderIcon={ArrowRight}>
+            How to contribute
+          </Link>
           <Link
             href="https://carbondesignsystem.com/"
             className="welcome__link"

diff --git a/.storybook/welcome/welcome.scss b/.storybook/welcome/welcome.scss
@@ -18,6 +18,10 @@
   color: colors.$gray-80;
 }
 
+.welcome__link {
+  width: fit-content;
+}
+
 .welcome__link,
 .welcome__link:hover,
 .welcome__link.cds--link:visited {

diff --git a/README.md b/README.md
@@ -1,4 +1,11 @@
-# @carbon-labs
+<p align="center">
+  <a href="https://www.carbondesignsystem.com">
+    <img alt="Carbon Design System" src="https://user-images.githubusercontent.com/3901764/57545698-ce5f2380-7320-11e9-8682-903df232d7b0.png" width="100%" />
+  </a>
+</p>
+<h1 align="center">
+  Carbon Labs
+</h1>
 
 > 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