Skip to content

Commit

Permalink
docs: beta install correct, beta tips add
Browse files Browse the repository at this point in the history
  • Loading branch information
JOU-amjs committed Jun 24, 2024
1 parent df5ae54 commit fc375dc
Show file tree
Hide file tree
Showing 18 changed files with 50 additions and 38 deletions.
4 changes: 2 additions & 2 deletions docs/release-notes-v3.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 'alova v3.0 Release Notes'
title: alova v3.0 Release Notes
---

:::warning beta reminder

The release log of [email protected] is currently in the beta stage and may be changed later. Please use it with caution.
[email protected] is currently in the beta stage, and some functions may be changed. If you find a bug, please let us know in [Github issues](https://github.com/alovajs/alova/issues/new/choose), and we will solve it as soon as possible.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/resource/01-request-adapter/01-alova-mock.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ This mock plug-in is an alova request adapter. Different from the traditional Pr
<TabItem value="1" label="npm">

```bash
npm install @alova/mock --save
npm install @alova/mock@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/mock
yarn add @alova/mock@beta
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/resource/01-request-adapter/02-alova-adapter-xhr.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-xhr --save
npm install @alova/adapter-xhr@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-xhr
yarn add @alova/adapter-xhr@beta
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/resource/01-request-adapter/03-alova-adapter-axios.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-axios --save
npm install @alova/adapter-axios@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-axios
yarn add @alova/adapter-axios@beta
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/resource/01-request-adapter/04-alova-adapter-taro.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ This plugin only supports the taro application of react 16.8+, vue3 version.
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-taro --save
npm install @alova/adapter-taro@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-taro
yarn add @alova/adapter-taro@beta
```

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/resource/01-request-adapter/05-alova-adapter-uniapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ This plugin only supports vue3 version of uniapp application.
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-uniapp --save
npm install @alova/adapter-uniapp@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-uniapp
yarn add @alova/adapter-uniapp@beta
```

</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/resource/02-storage-adapter/01-psc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Only supports Alova 3.0 and above.
## Install

```bash
npm install @alova/psc --save
npm install @alova/psc@beta --save
```

## Use in Node.js
Expand Down
4 changes: 2 additions & 2 deletions docs/resource/03-framework/07-vue-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ Usually, use hook can only be used in vue's setup, but through the auxiliary fun
<TabItem value="1" label="npm">

```bash
npm install alova @alova/vue-options --save
npm install alova @alova/vue-options@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add alova @alova/vue-options
yarn add alova @alova/vue-options@beta
```

</TabItem>
Expand Down
14 changes: 10 additions & 4 deletions docs/tutorial/02-getting-started/02-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ import EmbedSandpack from "@site/src/components/EmbedSandpack";
import quickStartGET from '!!raw-loader!@site/codesandbox/01-getting-started/02-first-request/get.js';
import quickStartPOST from '!!raw-loader!@site/codesandbox/01-getting-started/02-first-request/post.js';

:::warning beta reminder

[email protected] is currently in the beta stage, and some functions may be changed. If you find a bug, please let us know in [Github issues](https://github.com/alovajs/alova/issues/new/choose), and we will solve it as soon as possible.

:::

:::tip Example Tips

If you haven't learned about alova yet, it is recommended that you read [introduce alova](/next/tutorial/getting-started/introduce) first.
Expand All @@ -21,28 +27,28 @@ If you haven't learned about alova yet, it is recommended that you read [introdu
<TabItem value="1" label="npm">

```bash
npm install alova --save
npm install alova@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add alova
yarn add alova@beta
```

</TabItem>
<TabItem value="3" label="pnpm">

```bash
pnpm add alova
pnpm add alova@beta
```

</TabItem>
<TabItem value="4" label="bun">

```bash
bun add alova
bun add alova@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 'alova v3.0 Release Notes'
title: alova v3.0 发布日志
---

:::warning beta 提醒

[email protected] 的发布日志,目前处于 beta 阶段,后续可能有所改动,请谨慎使用
[email protected] 目前处于 beta 阶段,小部分功能可能会有所改动,如果发现 bug 请在[Github issues](https://github.com/alovajs/alova/issues/new/choose)中告诉我们,我们会在第一时间解决

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/mock --save
npm install @alova/mock@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/mock
yarn add @alova/mock@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-xhr --save
npm install @alova/adapter-xhr@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-xhr
yarn add @alova/adapter-xhr@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-axios --save
npm install @alova/adapter-axios@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-axios
yarn add @alova/adapter-axios@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-taro --save
npm install @alova/adapter-taro@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-taro
yarn add @alova/adapter-taro@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install @alova/adapter-uniapp --save
npm install @alova/adapter-uniapp@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add @alova/adapter-uniapp
yarn add @alova/adapter-uniapp@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ title: 进程共享适配器
## 安装

```bash
npm install @alova/ psc --save
npm install @alova/psc@beta --save
```

## 在 Node.js 中使用
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ import TabItem from '@theme/TabItem';
<TabItem value="1" label="npm">

```bash
npm install alova @alova/vue-options --save
npm install alova @alova/vue-options@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add alova @alova/vue-options
yarn add alova @alova/vue-options@beta
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ import EmbedSandpack from "@site/src/components/EmbedSandpack";
import quickStartGET from '!!raw-loader!@site/codesandbox/01-getting-started/02-first-request/get.js';
import quickStartPOST from '!!raw-loader!@site/codesandbox/01-getting-started/02-first-request/post.js';

:::warning beta 提醒

[email protected] 目前处于 beta 阶段,小部分功能可能会有所改动,如果发现 bug 请在[Github issues](https://github.com/alovajs/alova/issues/new/choose)中告诉我们,我们会在第一时间解决。

:::

:::tip 示例提示

如果你还未了解 alova,推荐你先阅读 [alova 介绍](/next/tutorial/getting-started/introduce)
Expand All @@ -21,28 +27,28 @@ import quickStartPOST from '!!raw-loader!@site/codesandbox/01-getting-started/02
<TabItem value="1" label="npm">

```bash
npm install alova --save
npm install alova@beta --save
```

</TabItem>
<TabItem value="2" label="yarn">

```bash
yarn add alova
yarn add alova@beta
```

</TabItem>
<TabItem value="3" label="pnpm">

```bash
pnpm add alova
pnpm add alova@beta
```

</TabItem>
<TabItem value="4" label="bun">

```bash
bun add alova
bun add alova@beta
```

</TabItem>
Expand Down

0 comments on commit fc375dc

Please sign in to comment.