Skip to content

Commit b0256f6

Browse files
author
Kurt Medley
committed
docs(storybook): intro
1 parent 29c4f9b commit b0256f6

4 files changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
# Cedar One · ![Alpha](https://img.shields.io/badge/status-alpha-orange)
77

8-
Cedar One is [Cedar](http://cedar.rei.com), distilled. A token-driven foundation that delivers consistent design across platforms while shipping less code, avoiding framework lock-in, and scaling through explicit adapters.
8+
Cedar One provides a framework-agnostic, CSS-first foundation for the
9+
[Cedar design system](https://cedar.rei.com). It delivers consistent design across platforms while shipping less code and avoiding framework lock-in through explicit adapters.
910

1011
Explore the system in practice:
1112
[HTML](https://rei.github.io/rei-cedar-one/html) · [Vue](https://rei.github.io/rei-cedar-one/vue) · [React](https://rei.github.io/rei-cedar-one/react)

apps/html/.storybook/preview.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ export const parameters = {
7272
},
7373
options: {
7474
storySort: {
75+
order: ['Introduction', '*'],
7576
method: 'alphabetical',
7677
},
7778
},

apps/html/stories/Introduction.mdx

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,27 @@
11
<div className="sb-unstyled cdr-prose c1-story-pad-24 c1-story-max-640">
22

3-
## Cedar One
3+
<h1 className="cdr-not-prose cdr-title">Cedar One</h1>
44

5-
This Storybook is the baseline catalog for Cedar One: plain HTML and static CSS.
6-
It anchors visual parity with `rei-cedar` while keeping the system portable and light.
5+
Cedar One provides a framework-agnostic, CSS-first foundation for <a className="cdr-link" href="http://cedar.rei.com">Cedar</a>.
6+
Tokens define design intent. Components ship as native HTML and static CSS, with behavior added only when needed.
77

8-
### A CSS-first component system
9-
10-
Cedar One reimagines <a className="cdr-link" href="http://cedar.rei.com">Cedar</a> as a framework-agnostic, CSS-first component system.
8+
<div className="cdr-not-prose c1-story-my-48" />
119

12-
Tokens define design intent. Styles resolve to native HTML and static CSS. Behavior is added only where parity and accessibility require it.
10+
### A CSS-first component system
1311

1412
```html
1513
<button class="cdr-button cdr-button--primary" type="button">
1614
Add to cart
1715
</button>
1816
```
1917

20-
Renders this:
18+
<div className="c1-story-mt-16" />
2119

22-
<div className="c1-story-flex c1-story-justify-start">
23-
<button type="button" className="cdr-button cdr-button--primary">
24-
{`Add to cart`}
25-
</button>
26-
</div>
20+
Renders this: <button type="button" className="cdr-button cdr-button--primary">{`Add to cart`}</button>
2721

2822
No runtime JavaScript required.
2923

30-
<hr className="cdr-not-prose c1-story-my-48" />
24+
<div className="cdr-not-prose c1-story-my-48" />
3125

3226
### Contracts, enforced before runtime
3327

@@ -111,7 +105,7 @@ Result:
111105
alt="Example ESLint error showing an unknown Cedar One class modifier."
112106
/>
113107

114-
<hr className="cdr-not-prose c1-story-my-48" />
108+
<div className="cdr-not-prose c1-story-my-48" />
115109

116110
### Adapters at the edges
117111

@@ -140,7 +134,7 @@ import { useAccordionAdapter } from '@rei/c1-ui/adapters/accordion/vue';
140134
useAccordionAdapter({ refs, state });
141135
```
142136

143-
<hr className="cdr-not-prose c1-story-my-48" />
137+
<div className="cdr-not-prose c1-story-my-48" />
144138

145139
### Design principles
146140

apps/storybook/storybook.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,10 @@
180180
margin-top: 8px;
181181
}
182182

183+
.c1-story-mt-16 {
184+
margin-top: 16px;
185+
}
186+
183187
.c1-story-my-24 {
184188
margin-block: 24px;
185189
}

0 commit comments

Comments
 (0)