docs: modify docs

sheinsight · Sep 2, 2024 · ef04fd2 · ef04fd2
1 parent 60996e7
commit ef04fd2
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 8 deletions.
diff --git a/docs/docs/en/docs/get-started.mdx b/docs/docs/en/docs/get-started.mdx
@@ -75,4 +75,4 @@ import { App } from '@/../../src/use-async-fn/demo'
 
 Next, it is recommended to read [Getting Started](/docs/get-started) to understand how to use this library.
 
-Then you can proceed to the [Usage Guide](/docs/guide) to learn how to improve existing code, or visit the [Hooks List](/reference) to see all available Hooks.
+Then you can proceed to the [Usage Guide](/docs/usage-guide) to learn how to improve existing code, or visit the [Hooks List](/reference) to see all available Hooks.
diff --git a/docs/docs/en/docs/overview.mdx b/docs/docs/en/docs/overview.mdx
@@ -1,7 +1,5 @@
 # 🔍 Overview \{#overview}
 
-## 💬 Preface
-
 To address a variety of complex and diverse business scenarios, this library provides a large number of **high-quality, efficient** React Hooks to help you build applications faster. It covers aspects ranging from basic `effect handling`, `data fetching`, `state management`, `UI state`, `utility tools` to more business-oriented uses like `browser API`, `common scenes`, `high-frequency business logic`, and more.
 
 **Please, don't panic. Not all Hooks need to be mastered.**

diff --git a/docs/docs/en/docs/guide.mdx → docs/docs/en/docs/usage-guide.mdx b/docs/docs/en/docs/guide.mdx → docs/docs/en/docs/usage-guide.mdx
diff --git a/docs/docs/zh-cn/docs/get-started.mdx b/docs/docs/zh-cn/docs/get-started.mdx
@@ -75,4 +75,4 @@ import { App } from '@/../../src/use-async-fn/demo'
 
 接下来，建议阅读 [起步](/docs/get-started) 了解如何使用本库。
 
-然后你可以前往 [使用指引](/docs/guide) 了解如何改进现有代码，或访问 [Hooks 列表](/reference) 查看所有可用的 Hooks。
+然后你可以前往 [使用指引](/docs/usage-guide) 了解如何改进现有代码，或访问 [Hooks 列表](/reference) 查看所有可用的 Hooks。
diff --git a/docs/docs/zh-cn/docs/overview.mdx b/docs/docs/zh-cn/docs/overview.mdx
@@ -1,7 +1,5 @@
 # 🔍 概览 \{#overview}
 
-## 💬 前言 \{#preface}
-
 为了应对各种复杂多样的业务场景，本库提供了大量**高质量、高效率**的 React Hooks 来帮助你更快地构建应用，涵盖了从基础的 `副作用处理`、`数据请求`、`状态管理`、`UI 状态`、`实用工具` 到偏业务的 `浏览器 API`、`常见场景`、`高频业务逻辑` 等各个方面。
 
 **无需慌张，并非所有的 Hooks 都需要掌握。**

diff --git a/docs/docs/zh-cn/docs/guide.mdx → docs/docs/zh-cn/docs/usage-guide.mdx b/docs/docs/zh-cn/docs/guide.mdx → docs/docs/zh-cn/docs/usage-guide.mdx
diff --git a/docs/locale.ts b/docs/locale.ts
@@ -23,7 +23,7 @@ export const sidebar = {
       },
       {
         text: '🧭 Usage Guide',
-        link: '/docs/guide',
+        link: '/docs/usage-guide',
       },
       {
         text: '✨ Features',
@@ -89,7 +89,7 @@ export const sidebar = {
       },
       {
         text: '🧭 使用指引',
-        link: `/${langSlug.zhCN}/docs/guide`,
+        link: `/${langSlug.zhCN}/docs/usage-guide`,
       },
       {
         text: '✨ 功能特性',
Original file line number	Diff line number	Diff line change
Expand Up		@@ -75,4 +75,4 @@ import { App } from '@/../../src/use-async-fn/demo'

		Next, it is recommended to read [Getting Started](/docs/get-started) to understand how to use this library.

		Then you can proceed to the [Usage Guide](/docs/guide) to learn how to improve existing code, or visit the [Hooks List](/reference) to see all available Hooks.
		Then you can proceed to the [Usage Guide](/docs/usage-guide) to learn how to improve existing code, or visit the [Hooks List](/reference) to see all available Hooks.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -75,4 +75,4 @@ import { App } from '@/../../src/use-async-fn/demo'

		接下来，建议阅读 [起步](/docs/get-started) 了解如何使用本库。

		然后你可以前往 [使用指引](/docs/guide) 了解如何改进现有代码，或访问 [Hooks 列表](/reference) 查看所有可用的 Hooks。
		然后你可以前往 [使用指引](/docs/usage-guide) 了解如何改进现有代码，或访问 [Hooks 列表](/reference) 查看所有可用的 Hooks。