From c815906a23a65f8e211419f4c3b3b41a878a7272 Mon Sep 17 00:00:00 2001 From: Joe Chen Date: Tue, 26 Sep 2023 07:53:14 +0800 Subject: [PATCH] docs: change reference contents to developer-guides (#865) --- .../docs/developer-guides/library.en-US.mdx | 15 +++++++++++++++ .../docs/developer-guides/library.zh-CN.mdx | 15 +++++++++++++++ .../rooch-rpc.en-US.mdx} | 4 ++-- .../rooch-rpc.zh-CN.mdx} | 6 +++--- .../pages/docs/reference/_meta.en-US.json | 4 ---- .../pages/docs/reference/_meta.zh-CN.json | 4 ---- .../pages/docs/reference/framework.en-US.mdx | 18 ------------------ .../pages/docs/reference/framework.zh-CN.mdx | 18 ------------------ 8 files changed, 35 insertions(+), 49 deletions(-) create mode 100644 docs/website/pages/docs/developer-guides/library.en-US.mdx create mode 100644 docs/website/pages/docs/developer-guides/library.zh-CN.mdx rename docs/website/pages/docs/{reference/rpc.en-US.mdx => developer-guides/rooch-rpc.en-US.mdx} (85%) rename docs/website/pages/docs/{reference/rpc.zh-CN.mdx => developer-guides/rooch-rpc.zh-CN.mdx} (55%) delete mode 100644 docs/website/pages/docs/reference/_meta.en-US.json delete mode 100644 docs/website/pages/docs/reference/_meta.zh-CN.json delete mode 100644 docs/website/pages/docs/reference/framework.en-US.mdx delete mode 100644 docs/website/pages/docs/reference/framework.zh-CN.mdx diff --git a/docs/website/pages/docs/developer-guides/library.en-US.mdx b/docs/website/pages/docs/developer-guides/library.en-US.mdx new file mode 100644 index 0000000000..c6fb34e36b --- /dev/null +++ b/docs/website/pages/docs/developer-guides/library.en-US.mdx @@ -0,0 +1,15 @@ +# Rooch's built-in library + +Rooch currently has three built-in standard libraries, namely `MoveStdlib`, `MoveosStdlib` and `RoochFramework`. + +The addresses of the three libraries in Move are: + +- `MoveStdlib`: `0x1` +- `MoveosStdlib`: `0x2` +- `RoochFramework`: `0x3` + +## Documentation link + +- [MoveStdlib](https://github.com/rooch-network/rooch/tree/main/moveos/moveos-stdlib/move-stdlib/doc) +- [MoveosStdlib](https://github.com/rooch-network/rooch/edit/main/moveos/moveos-stdlib/moveos-stdlib/doc) +- [RoochFramework](https://github.com/rooch-network/rooch/tree/main/crates/rooch-framework/doc) diff --git a/docs/website/pages/docs/developer-guides/library.zh-CN.mdx b/docs/website/pages/docs/developer-guides/library.zh-CN.mdx new file mode 100644 index 0000000000..eb7c97887c --- /dev/null +++ b/docs/website/pages/docs/developer-guides/library.zh-CN.mdx @@ -0,0 +1,15 @@ +# Rooch 的内置库 + +Rooch 当前内置了三个标准库，分别是 `MoveStdlib`、`MoveosStdlib` 和 `RoochFramework`。 + +三个库在 Move 中的地址分别是： + +- `MoveStdlib`：`0x1` +- `MoveosStdlib`：`0x2` +- `RoochFramework`：`0x3` + +## 文档链接 + +- [MoveStdlib](https://github.com/rooch-network/rooch/tree/main/moveos/moveos-stdlib/move-stdlib/doc) +- [MoveosStdlib](https://github.com/rooch-network/rooch/edit/main/moveos/moveos-stdlib/moveos-stdlib/doc) +- [RoochFramework](https://github.com/rooch-network/rooch/tree/main/crates/rooch-framework/doc) diff --git a/docs/website/pages/docs/reference/rpc.en-US.mdx b/docs/website/pages/docs/developer-guides/rooch-rpc.en-US.mdx similarity index 85% rename from docs/website/pages/docs/reference/rpc.en-US.mdx rename to docs/website/pages/docs/developer-guides/rooch-rpc.en-US.mdx index 889d134290..ae343e7e18 100644 --- a/docs/website/pages/docs/reference/rpc.en-US.mdx +++ b/docs/website/pages/docs/developer-guides/rooch-rpc.en-US.mdx @@ -1,9 +1,9 @@ -# Rooch JSON-RPC Document +# Rooch JSON-RPC ## Type Conversions - `u64`, `u128`, `u256` are represented as strings in JSON. -- `ObjectID` and `address` are represented in JSON as hexadecimal strings beginning with '0x'. +- `ObjectID` and `address` are represented in JSON as hexadecimal strings beginning with `0x`. ## Reference diff --git a/docs/website/pages/docs/reference/rpc.zh-CN.mdx b/docs/website/pages/docs/developer-guides/rooch-rpc.zh-CN.mdx similarity index 55% rename from docs/website/pages/docs/reference/rpc.zh-CN.mdx rename to docs/website/pages/docs/developer-guides/rooch-rpc.zh-CN.mdx index 23bbe8fe1d..3465e88ceb 100644 --- a/docs/website/pages/docs/reference/rpc.zh-CN.mdx +++ b/docs/website/pages/docs/developer-guides/rooch-rpc.zh-CN.mdx @@ -1,9 +1,9 @@ -# Rooch JSON-RPC 文档 +# Rooch JSON-RPC ## 类型转换说明 -- `u64`, `u128`, `u256` 在 json 中用 string 来表达 -- `ObjectID`, `address` 在 json 中用以 `0x` 开头的 hex string 来表达。 +- `u64`、`u128`、`u256` 在 JSON 中用 string 来表示。 +- `ObjectID` 和 `address` 在 JSON 中用以 `0x` 开头的 hex string 来表示。 ## 引用 diff --git a/docs/website/pages/docs/reference/_meta.en-US.json b/docs/website/pages/docs/reference/_meta.en-US.json deleted file mode 100644 index bec580ccea..0000000000 --- a/docs/website/pages/docs/reference/_meta.en-US.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "framework": "Rooch Framework", - "rpc": "Rooch JSON-RPC" -} diff --git a/docs/website/pages/docs/reference/_meta.zh-CN.json b/docs/website/pages/docs/reference/_meta.zh-CN.json deleted file mode 100644 index bec580ccea..0000000000 --- a/docs/website/pages/docs/reference/_meta.zh-CN.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "framework": "Rooch Framework", - "rpc": "Rooch JSON-RPC" -} diff --git a/docs/website/pages/docs/reference/framework.en-US.mdx b/docs/website/pages/docs/reference/framework.en-US.mdx deleted file mode 100644 index 57301114be..0000000000 --- a/docs/website/pages/docs/reference/framework.en-US.mdx +++ /dev/null @@ -1,18 +0,0 @@ -# Rooch Framework Document - -Rooch currently includes three built-in Move standard libraries, namely `MoveStdlib`, `MoveosStdlib`, and `RoochFramework`. -The addresses of the three libraries in Move are as follows: - -* `MoveStdlib` : `0x1` -* `MoveosStdlib` : `0x2` -* `RoochFramework` : `0x3` - -## Reference - -* [MoveStdlib](https://github.com/rooch-network/rooch/tree/main/moveos/moveos-stdlib/move-stdlib/doc) -* [MoveosStdlib](https://github.com/rooch-network/rooch/edit/main/moveos/moveos-stdlib/moveos-stdlib/doc/) -* [RoochFramework](https://github.com/rooch-network/rooch/tree/main/crates/rooch-framework/doc) - -## Examples - -* [Examples](https://github.com/rooch-network/rooch/tree/main/examples) \ No newline at end of file diff --git a/docs/website/pages/docs/reference/framework.zh-CN.mdx b/docs/website/pages/docs/reference/framework.zh-CN.mdx deleted file mode 100644 index 45c0ed669d..0000000000 --- a/docs/website/pages/docs/reference/framework.zh-CN.mdx +++ /dev/null @@ -1,18 +0,0 @@ -# Rooch Framework 文档 - -Rooch 当前内置了三个 Move 标准库，分别是 `MoveStdlib`、`MoveosStdlib` 和 `RoochFramework`。 -三个库在 Move 中的地址分别是： - -* `MoveStdlib` : `0x1` -* `MoveosStdlib` : `0x2` -* `RoochFramework` : `0x3` - -## 文档链接 - -* [MoveStdlib](https://github.com/rooch-network/rooch/tree/main/moveos/moveos-stdlib/move-stdlib/doc) -* [MoveosStdlib](https://github.com/rooch-network/rooch/edit/main/moveos/moveos-stdlib/moveos-stdlib/doc/) -* [RoochFramework](https://github.com/rooch-network/rooch/tree/main/crates/rooch-framework/doc) - -## 使用案例 - -* [Examples](https://github.com/rooch-network/rooch/tree/main/examples)