Skip to content

Commit

Permalink
update doc structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jueduizone committed Jun 19, 2024
1 parent 963c1ec commit 0a8c7e9
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 21 deletions.
23 changes: 16 additions & 7 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export default defineConfig({
{
text: '1. 简介',
collapsed: false,
link: '/swaybook/introduction/index',
link: '/swaybook/introduction/',
items: [
{ text: '1.1 入门指南', link: '/swaybook/introduction/getting_started' },
{ text: '1.2 Fuel 工具链', link: '/swaybook/introduction/fuel_toolchain' },
Expand Down Expand Up @@ -228,8 +228,19 @@ export default defineConfig({
],
'/typescript-sdk': [
{
text: '入门指南',
link: '/typescript-sdk/getting-started.md',
text: 'Geting Started',
link: '/typescript-sdk/get-start',
collapsed: true,
items: [
{
text: '概述',
link: '/typescript-sdk/get-start/',
},
{
text: '入门指南',
link: '/typescript-sdk/get-start/getting-started',
},
]
},
{
text: '创建一个 Fuel dApp',
Expand Down Expand Up @@ -711,8 +722,8 @@ export default defineConfig({
"/sway-applications" : [
{
text: '构建市场dApp',
link: '/sway-applications/market/index',
collapsed: true,
link: '/sway-applications/market/',
collapsed: false,
items: [
{ text: '基础条件', link: '/sway-applications/market/prerequisites' },
{ text: '项目导入', link: '/sway-applications/market/imports' },
Expand All @@ -723,8 +734,6 @@ export default defineConfig({
{ text: '合约检查站', link: '/sway-applications/market/checkpoint' },
{ text: '合约测试', link: '/sway-applications/market/test' },
{ text: '构建前端', link: '/sway-applications/market/typescript_frontend' },


]
},
]
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ hero:
actions:
- theme: brand
text: SwayBook 中文教程
link: /swaybook/introduction/index
link: /swaybook/introduction
- theme: alt
text: TypeScript SDK 中文教程
link: /typescript-sdk/index
link: /typescript-sdk/get-start
- theme: alt
text: Sway Example 中文教程
link: /sway-example/index
link: /sway-example/
- theme: alt
text: Sway applications 中文教程
link: /sway-applications/market/index
text: Sway 实战案例
link: /sway-applications/

features:
- icon: 🎉
Expand Down
3 changes: 2 additions & 1 deletion docs/sway-applications/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
这是sway应用示例的首页。
基于 Sway 构建的各类 Dapp 的实战案例。
欢迎各位开发者贡献你的案例/教程 🎉,在我们的 Github 提交 PR 即可。
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import { data } from './versions.data'
import { data } from '../versions.data'
const { fuels } = data
</script>

Expand Down Expand Up @@ -144,8 +144,8 @@ export default App;

首先,您需要在您的机器上运行一个本地节点。我们推荐以下方法之一:

- [测试工具](./guide/testing/index.md#wallet-test-utilities) 可以帮助您以编程方式启动一个短暂的节点。
- 直接运行 [fuel-core](https://docs.fuel.network/guides/running-a-node/running-a-local-node/),或通过 CLI [fuels](./guide/fuels-cli/commands.md#fuels-core)
- [测试工具](../guide/testing/index.md#wallet-test-utilities) 可以帮助您以编程方式启动一个短暂的节点。
- 直接运行 [fuel-core](https://docs.fuel.network/guides/running-a-node/running-a-local-node/),或通过 CLI [fuels](../guide/fuels-cli/commands.md#fuels-core)

在以下示例中,我们创建了一个提供程序以连接到本地节点并签署消息。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup>
import { data } from './versions.data'
import { data } from '../versions.data'
const { forc, fuels, fuelCore } = data
const url = `https://docs.fuel.network/docs/forc/`
const logoSrc = './fuel-logo.png'
Expand Down
4 changes: 2 additions & 2 deletions docs/typescript-sdk/guide/provider/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Provider

[`Provider`](../../api/Account/Provider) 允许您连接到 Fuel 节点([_*本地*_](../../getting-started.md#connecting-to-a-local-node)[_*外部*_](../../getting-started.md#connecting-to-the-testnet))并与其进行交互,封装了 SDK 中的常见客户端操作。这些操作包括查询区块链以获取网络、区块和与交易相关的信息(以及[更多](../../api/Account/Provider)),以及向区块链发送[交易](../transactions/index)
[`Provider`](../../api/Account/Provider) 允许您连接到 Fuel 节点([_*本地*_](../../get-start/getting-started.md#connecting-to-a-local-node)[_*外部*_](../../get-start/getting-started.md#connecting-to-the-testnet))并与其进行交互,封装了 SDK 中的常见客户端操作。这些操作包括查询区块链以获取网络、区块和与交易相关的信息(以及[更多](../../api/Account/Provider)),以及向区块链发送[交易](../transactions/index)

所有与区块链交互的高级抽象(例如[`Wallet`](../wallets/index)[`Contract`](../contracts/index)等)都通过 `Provider` 进行,因此它用于各种操作,如获取钱包余额、部署合约、查询其状态等。

<<< ../../docs-snippets/src/guide/provider/provider.test.ts#provider-definition{ts:line-numbers}

您可以在[这里](querying-the-chain)找到更多关于 `Provider` 使用的示例。
您可以在[这里](querying-the-chain)找到更多关于 `Provider` 使用的示例。
4 changes: 2 additions & 2 deletions docs/typescript-sdk/guide/provider/querying-the-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

我们可以连接到一个 _*本地*_ 或者一个 _*外部*_ 节点:

> 1. _运行一个[本地节点](../../getting-started.md#connecting-to-a-local-node)_
> 1. _连接到一个[外部节点](../../getting-started.md#connecting-to-the-testnet)_
> 1. _运行一个[本地节点](../../get-start/getting-started.md#connecting-to-a-local-node)_
> 1. _连接到一个[外部节点](../../get-start/getting-started.md#connecting-to-the-testnet)_
让我们看一下下面的一些示例。

Expand Down

0 comments on commit 0a8c7e9

Please sign in to comment.