Skip to content

Commit

Permalink
update sidebar, translate welcome and overview pages (#1711)
Browse files Browse the repository at this point in the history
* update learn sidebar

* translate welcome page and clean up old page

* update and translate overview page

* update sidebar

* fix error links
  • Loading branch information
geometryolife authored May 21, 2024
1 parent eb3cf1a commit 84d589a
Show file tree
Hide file tree
Showing 10 changed files with 112 additions and 66 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Rooch uses [GitHub issues](https://github.com/rooch-network/rooch/issues) to tra

## Documentations

All developer documentation is published on the Rooch developer site, [rooch.network](https://rooch.network/learn/introduction).
All developer documentation is published on the Rooch developer site, [rooch.network](https://rooch.network/learn/welcome).

## Code of Conduct

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Rooch 使用 [GitHub issues](https://github.com/rooch-network/rooch/issues) 跟

## 文档

所有开发者文档均发布在 Rooch 开发者网站 [rooch.network](https://rooch.network/learn/introduction)
所有开发者文档均发布在 Rooch 开发者网站 [rooch.network](https://rooch.network/learn/welcome)

## 行为准则

Expand Down
11 changes: 5 additions & 6 deletions docs/website/pages/learn/_meta.zh-CN.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"introduction": "简介",
"rooch": "Rooch",
"core-concepts": "核心概念",
"welcome": "欢迎",
"overview": "概览",
"in-depth-tech": "深入技术",
"user-guides": "用户指南",
"contribution-guides": "贡献指南",
"miscellaneous": "其他"
"core-concepts": "核心概念",
"miscellaneous": "其他",
"contribution-guides": "贡献指南"
}
1 change: 0 additions & 1 deletion docs/website/pages/learn/core-concepts/_meta.zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"transaction": "交易",
"objects": "对象",
"move-contracts": "Move 概念",
"client-side-validation": "客户端验证",
"token": {
"title": "Token",
"display": "hidden"
Expand Down
18 changes: 4 additions & 14 deletions docs/website/pages/learn/in-depth-tech/_meta.zh-CN.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
{
"fraud-proof": "欺诈证明",
"hybrid-security": "基于零知识证明的混合安全机制",
"multi-chain-settlement": "多链结算",
"on-chain-indexer": {
"title": "链上索引器",
"display": "hidden"
},
"decentralized-validator": "去中心化验证者",
"client-side-validation": "客户端认证",
"dstp":"DSTP",
"pipeline-transaction-processing": "基于流水线的并行交易处理",
"decentralized-validator": "去中心化验证者",
"sequence-proof": "交易排序证明",
"hash": "哈希",
"session-key": "会话密钥",
"p2p-state-channel": {
"title": "P2P 通道",
"display": "hidden"
}
"security": "安全性"
}
28 changes: 0 additions & 28 deletions docs/website/pages/learn/introduction.zh-CN.mdx

This file was deleted.

22 changes: 10 additions & 12 deletions docs/website/pages/learn/overview.en-US.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Rooch Overview

import Image from "next/image";

<Image
src="/docs/rooch-bitcoin-application-layer.png"
alt="Rooch as Bitcoin Application Layer"
Expand All @@ -10,12 +12,11 @@


The Rooch project aims to build the application layer of Bitcoin ecosystem. The Rooch project takes a native approach to extend the functionalities of Bitcoin blockchain and enables decentralized applications for Bitcoin assets, with the Bitcoin level security.
- If you are a user who are looking into paly with some Bitcoin applications, you may find that all your Bitcoin assets, including BTC, Ordinals or BRC20 assets, can be used directly in all the Bitcoin Apps powered by Rooch, without going through a custodial bridge

- If you are a user who are looking into play with some Bitcoin applications, you may find that all your Bitcoin assets, including BTC, Ordinals or BRC20 assets, can be used directly in all the Bitcoin Apps powered by Rooch, without going through a custodial bridge
- If you are a developer who wants to build an app with Bitcoin assets, Rooch provides you with an easy to program environment with MoveVM and the full access to all Bitcoin states from your smart contracts, which means your app can
- If you are a community member who hold some assets from any Bitcoin apps, Rooch makes sure that all your assets are Bitcoin L1 native assets that can be leaped back to Bitcoin L1 at any time without permissions.



## Architecture

Rooch is a verfiable application (VApp) execution runtime container for Bitcoin blockchain with the following features:
Expand All @@ -24,9 +25,6 @@ Rooch is a verfiable application (VApp) execution runtime container for Bitcoin
- **Bitcoin Full State** - Rooch has the full state of Bitcoin blockchain which can work with smart contract based interpreter to identify not only plain UTXO but also Ordinals based asset protocol such BRC20
- **Scalable** - Rooch is a fast execution environment that can achieve 100k peak TPS powered by parallel execuion


import Image from "next/image";

<Image
src="/docs/rooch-architecture.png"
alt="Rooch Architecture"
Expand All @@ -37,11 +35,11 @@ import Image from "next/image";

Rooch is composed of the core component MoveOS as well as interfaces and tools for accessing smart contracts and states.

**MoveOS** is the component that does all the computation and state storage work.
- **MoveVM** is a full function turing-complete VM that executes smart contracts written in [Move Language](/learn/core-concepts/move-contracts/move-language)
- **flexEmu** is a general purpose MIPS emulator that generates [Fraud Proof](/learn/in-depth-tech/fraud-proof) from MoveVM
- **State Storage** contains the full state of Bitcoin blockchain and the application states
- **Frameworks** contains the modules for interpreting the Bitcoin state and the standard Move libraries, along with customized Rooch Framework which provide rich features for a better dev exerperience
- **MoveOS** is the component that does all the computation and state storage work.
- **MoveVM** is a full function turing-complete VM that executes smart contracts written in [Move Language](/learn/core-concepts/move-contracts/move-language)
- **flexEmu** is a general purpose MIPS emulator that generates [Fraud Proof](/learn/in-depth-tech/fraud-proof) from MoveVM
- **State Storage** contains the full state of Bitcoin blockchain and the application states
- **Frameworks** contains the modules for interpreting the Bitcoin state and the standard Move libraries, along with customized Rooch Framework which provide rich features for a better dev exerperience

## Usage

Expand All @@ -63,4 +61,4 @@ Rooch allows the state transitions in the applications smart contracts to be bin
### CSV Assets
Client Side Validation Assets (CSV Assets) are the core for enabling all innovations in the Bitcoin ecosystem. Rooch provides a metaprotocol design of Ordinals called Bitseed to enable the CSV asset leaping between Bitcoin states and the Rooch application states, making all Bitcoin assets can be leaped into any of the Rooch based Bitcoin applications in a permissionless way.

> For more details, please refer to [CSV Assets](./in-depth-tech/client-side-validation.en-US.mdx)
> For more details, please refer to [CSV Assets](./in-depth-tech/client-side-validation.en-US.mdx)
65 changes: 65 additions & 0 deletions docs/website/pages/learn/overview.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Rooch 概览

import Image from "next/image";

<Image
src="/docs/rooch-bitcoin-application-layer.png"
alt="Rooch as Bitcoin Application Layer"
width={1000}
height={1000}
className="mx-auto my-2"
/>

Rooch 项目旨在构建比特币生态系统的应用层。Rooch 项目采用原生方法来扩展比特币区块链的功能,并实现比特币资产的去中心化应用,且具有比特币级别的安全性。

- 如果您是正在使用某些比特币应用程序的用户,您可能会发现您的所有比特币资产,包括 BTC、Ordinals 或 BRC20 资产,都可以直接在 Rooch 支持的所有比特币应用程序中使用,无需经过托管桥
- 如果您是一名想要使用比特币资产构建应用程序的开发人员,Rooch 为您提供了一个易于编程的 `MoveVM` 环境,并可以通过您的智能合约完全访问所有比特币状态,这意味着您的应用程序可以
- 如果您是社区成员,持有任何比特币应用程序中的一些资产,Rooch 会确保您的所有资产都是比特币 L1 原生资产,无需许可即可随时跃迁到比特币 L1。

## 架构

Rooch 是比特币区块链的可验证应用程序(VApp)执行运行时容器,具有以下功能:

- **MoveVM** - Rooch 嵌入了完整的 MoveVM,供开发人员使用 Move 语言对智能合约进行编程
- **比特币完整状态** - Rooch 拥有比特币区块链的完整状态,它可以与基于智能合约的解释器配合使用,不仅可以识别普通的 UTXO,还可以识别基于 Ordinals 的资产协议,例如 BRC20
- **可扩展** - Rooch 是一个快速执行环境,可通过并行执行实现 100k 峰值 TPS

<Image
src="/docs/rooch-architecture.png"
alt="Rooch Architecture"
width={600}
height={600}
className="mx-auto my-4"
/>

Rooch 由核心组件 MoveOS 以及用于访问智能合约和状态的接口和工具组成。

- **MoveOS** 是完成所有计算和状态存储工作的组件。
- **MoveVM** 是一个全功能图灵完备的 VM,执行用 [Move 语言](/learn/core-concepts/move-contracts/move-language)编写的智能合约
- **flexEmu** 是一个通用 MIPS 模拟器,可从 MoveVM 生成[欺诈证明](/learn/in-depth-tech/fraud-proof)
- **状态存储**包含比特币区块链的完整状态和应用程序状态
- **Frameworks** 包含用于解释比特币状态的模块和标准 Move 库,以及定制的 Rooch 框架,为更好的开发体验提供丰富的功能

## Usage

<Image
src="/docs/rooch-usage.png"
alt="Rooch Usage"
width={600}
height={600}
className="mx-auto my-4"
/>

Rooch 提供了两种构建比特币应用程序的方法:状态绑定和 CSV 资产跃迁。

### 状态绑定

Rooch 允许应用程序智能合约中的状态转换与比特币状态绑定。借助 Rooch 中可用的完整比特币状态,智能合约可以访问和读取所有比特币状态并解释它们以获取有关用户的比特币地址及其控制下的资产的信息。状态绑定机制允许一个应用程序状态与某个比特币 UTXO 的状态绑定,无论是普通 UTXO 还是 Ordinals UTXO。

> 欲了解更多详情,请参阅 [Stackable L2](https://rooch.network/blog/stackable-l2)
### CSV资产

客户端验证资产(CSV 资产)是实现比特币生态系统中所有创新的核心。Rooch 提供了一种称为 Bitseed 的 Ordinals 元协议设计,可以实现 CSV 资产在比特币状态和 Rooch 应用程序状态之间跃迁,使得所有比特币资产都可以以无需许可的方式跃迁到任何基于 Rooch 的比特币应用程序中。

更多详情请参阅 [CSV 资产](./in-depth-tech/client-side-validation.en-US.mdx)
5 changes: 2 additions & 3 deletions docs/website/pages/learn/welcome.en-US.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import Image from "next/image";
/>
</div>

Rooch (/ruʧ/) is named by combining Root and Branch symbolizing the inspiration we get from how roots and branches are grown out of a seed and seeds can be spread out to grow a forest ecosystem, where, we believe Bitcoin is the seed we need, and building for the Bitcoin ecosystem is THE path towards Web3 vision.
Rooch (/ruʧ/) is named by combining Root and Branch symbolizing the inspiration we get from how roots and branches are grown out of a seed and seeds can be spread out to grow a forest ecosystem, where, we believe Bitcoin is the seed we need, and building for the Bitcoin ecosystem is the path towards Web3 vision.

In this doc you will learn about how Rooch is designed to be a verifiable application contrainer and serve as the application layer for Bitcoin.
If you are interested please also go through our Blog posts for more technical discussions.
In this doc you will learn about how Rooch is designed to be a verifiable application contrainer and serve as the application layer for Bitcoin. If you are interested please also go through our Blog posts for more technical discussions.
24 changes: 24 additions & 0 deletions docs/website/pages/learn/welcome.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Welcome to Rooch

import Image from "next/image";

<div>
<Image
src="/logo/rooch_black_combine.svg"
alt="Rooch Architecture"
width={600}
height={600}
className="dark:hidden"
/>
<Image
src="/logo/rooch_white_combine.svg"
alt="Rooch Architecture"
width={600}
height={600}
className="hidden dark:block"
/>
</div>

Rooch(/ruʧ/)的命名是 Root 和 Branch 的结合,象征着我们从种子中长出根和枝,并将种子传播到森林生态系统中所获得的灵感。我们相信比特币是我们的种子,构建比特币生态系统是实现 Web3 愿景的途径。

在本文档中,您将了解 Rooch 如何设计为可验证的应用程序容器并充当比特币的应用程序层。如果您有兴趣,还请浏览我们的博客文章以进行更多技术讨论。

0 comments on commit 84d589a

Please sign in to comment.