Skip to content

Commit

Permalink
Clean up obsolete docs (#5068)
Browse files Browse the repository at this point in the history
* Update Getting started on Welcome page

The sections referenced in the Getting Started seem no longer to exist, and included a broken link.

* Remove broken link from README

The Quick links section included a link to a README for the component-library package. This package does not currently have a README, so this link was broken.
  • Loading branch information
sentience authored Sep 20, 2024
1 parent ca8ac77 commit 218f3d0
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .changeset/real-shoes-relate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ This document serves to orient you within the repository — to get you set up a

- [Kaizen Issues](https://github.com/cultureamp/kaizen-discourse/issues)
- [Kaizen Design Tokens README](./packages/design-tokens/README.md)
- [Kaizen Component Library README](./packages/component-library/README.md)
- [Contributing guidelines](./CONTRIBUTING.md)

## Designers
Expand Down
7 changes: 0 additions & 7 deletions docs/pages/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,6 @@ To achieve this, Kaizen provides a set of React components and tokens which repr

You can find a comprehensive overview of how to get your code base started on our [Github page](https://github.com/cultureamp/kaizen-design-system#getting-started).

We have 4 main sections:
- Components: React components you can use in your Apps
- Helpers: Any hooks or utilities we provide
- Design tokens: Primarily used for creating new components that don't already exist.
- Deprecated: components which are on their way out. (Find out more on the [Component Health page](https://cultureamp.design/component-health/))


## Support

The Kaizen Design System Team is here to support the usage of the library via #prod_design_system channel on Slack.
Expand Down

0 comments on commit 218f3d0

Please sign in to comment.