Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jake-figma committed Jun 21, 2024
1 parent 71a73ba commit 2636930
Showing 1 changed file with 31 additions and 16 deletions.
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,37 @@ With the above in mind, a fresh clone of the Simple Design System Figma file sho

All components and styles are in [src/ui](./src/ui). Within that directory, code is broken down into a few categories.

- [compositions](./src/ui/compositions/)
- Example arrangements of primitive components to demonstrate how you might use SDS to build a responsive website.
- [hooks](./src/ui/hooks/)
- Custom React hook definitions
- [icons](./src/ui/icons/)
- All icon components. Automatically generated by [scripts/icons](./scripts/icons)
- [images](./src/ui/images/)
- Placeholder images.
- [layout](./src/ui/layout/)
- Layout components. Crucial to SDS layouts, but do not have analagous component in Figma.
- [primitives](./src/ui/primitives/)
- The main component library. SDS primitives can't be reduced further into sub components.
- [providers](./src/ui/providers/)
- Custom React provider definitions
- [utils](./src/ui/utils/)
- Custom utilities and utility components
### [compositions](./src/ui/compositions/)

Example arrangements of primitive components to demonstrate how you might use SDS to build a responsive website.

### [hooks](./src/ui/hooks/)

Custom React hook definitions

### [icons](./src/ui/icons/)

All icon components. Automatically generated by [scripts/icons](./scripts/icons)

### [images](./src/ui/images/)

Placeholder images.

### [layout](./src/ui/layout/)

Layout components. Crucial to SDS layouts, but do not have analagous component in Figma.

### [primitives](./src/ui/primitives/)

The main component library. SDS primitives can't be reduced further into sub components.

### [providers](./src/ui/providers/)

Custom React provider definitions

### [utils](./src/ui/utils/)

Custom utilities and utility components

All Code Connect docs and Storybook stories follow the same categorization are defined in [src/figma](./src/figma) and [src/stories](./src/stories).

Expand Down

0 comments on commit 2636930

Please sign in to comment.