Skip to content

Commit

Permalink
docs: use @alpha for installing packages (#121)
Browse files Browse the repository at this point in the history
## Description

Update the docs to install our packages with the `@alpha` channel
because we are currently in pre-release / alpha mode so trying to just
install `sit-onyx` would always install version `0.0.0` although we
already have e.g. version `1.0.0-alpha.1`
  • Loading branch information
larsrickert authored Jan 15, 2024
1 parent fe22feb commit 22aa446
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions apps/docs/src/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add sit-onyx
pnpm add sit-onyx@alpha
```

```sh [npm]
npm install sit-onyx
npm install sit-onyx@alpha
```

```sh [yarn]
yarn install sit-onyx
yarn install sit-onyx@alpha
```

:::
Expand Down
8 changes: 4 additions & 4 deletions apps/docs/src/packages/figma-utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import packageJson from "../../../../packages/figma-utils/package.json";
For a list of supported commands and options, run:

```sh
npx @sit-onyx/figma-utils@latest --help
npx @sit-onyx/figma-utils@alpha --help
```

::: tip Usage in CI
Expand All @@ -44,15 +44,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add @sit-onyx/figma-utils
pnpm add @sit-onyx/figma-utils@alpha
```

```sh [npm]
npm install @sit-onyx/figma-utils
npm install @sit-onyx/figma-utils@alpha
```

```sh [yarn]
yarn install @sit-onyx/figma-utils
yarn install @sit-onyx/figma-utils@alpha
```

:::
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/packages/headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add @sit-onyx/headless
pnpm add @sit-onyx/headless@alpha
```

```sh [npm]
npm install @sit-onyx/headless
npm install @sit-onyx/headless@alpha
```

```sh [yarn]
yarn install @sit-onyx/headless
yarn install @sit-onyx/headless@alpha
```

:::
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/packages/storybook-utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ Install the npm package with your corresponding package manager:
::: code-group

```sh [pnpm]
pnpm add -D @sit-onyx/storybook-utils
pnpm add -D @sit-onyx/storybook-utils@alpha
```

```sh [npm]
npm install -D @sit-onyx/storybook-utils
npm install -D @sit-onyx/storybook-utils@alpha
```

```sh [yarn]
yarn install -D @sit-onyx/storybook-utils
yarn install -D @sit-onyx/storybook-utils@alpha
```

:::
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/packages/vitepress-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ The theme includes the following features:
::: code-group

```sh [pnpm]
pnpm add -D @sit-onyx/vitepress-theme
pnpm add -D @sit-onyx/vitepress-theme@alpha
```

```sh [npm]
npm install -D @sit-onyx/vitepress-theme
npm install -D @sit-onyx/vitepress-theme@alpha
```

```sh [yarn]
yarn install -D @sit-onyx/vitepress-theme
yarn install -D @sit-onyx/vitepress-theme@alpha
```

:::
Expand Down

0 comments on commit 22aa446

Please sign in to comment.