Skip to content

Commit

Permalink
add rooch documents TOC (#831)
Browse files Browse the repository at this point in the history
* add rooch documents TOC

* using callout component

* fix

* re-organize the toc

* add example guides toc and contents

* merge the example guides into a single page

* add summary for some pages
  • Loading branch information
geometryolife authored Sep 21, 2023
1 parent d683fd3 commit 5aebd8d
Show file tree
Hide file tree
Showing 28 changed files with 364 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/website/pages/docs/_meta.en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
"introduction": "Introduction",
"rooch": "Rooch",
"rooch-network": "Rooch Network",
"getting-started": "Getting started with Rooch",
"tech-highlights": "Tech Highlights",
"developer": "Developer",
"getting-started": "Getting started with Rooch",
"user-guides": "User guides",
"developer-guides": "Developer guides",
"example-guides": "Example-guides",
"reference": "Reference",
"miscellaneous": "Miscellaneous"
}
6 changes: 4 additions & 2 deletions docs/website/pages/docs/_meta.zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
"introduction": "简介",
"rooch": "Rooch",
"rooch-network": "Rooch 网络",
"getting-started": "Rooch 新手入门",
"tech-highlights": "技术亮点",
"developer": "开发者",
"getting-started": "Rooch 新手入门",
"user-guides": "用户指南",
"developer-guides": "开发者指南",
"example-guides": "示例指南",
"reference": "引用",
"miscellaneous": "其他"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How interactive with Ethereum

1. What is Ethereum.
2. Rooch how to connect to the Ethereum network.
3. Rooch how to interactive with the Ethereum.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO: introduce that rooch CLI how to interactive with Ethereum network

This document is being improved!
</Callout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# How interactive with Ethereum

1. What is Ethereum.
2. Rooch how to connect to the Ethereum network.
3. Rooch how to interactive with the Ethereum.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO: introduce that rooch CLI how to interactive with Ethereum network

This document is being improved!
</Callout>
12 changes: 12 additions & 0 deletions docs/website/pages/docs/developer-guides/rooch-faucet.en-US.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to use Rooch faucet

1. Rooch faucet introduction.
2. How to obtain the Rooch's gas.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
12 changes: 12 additions & 0 deletions docs/website/pages/docs/developer-guides/rooch-faucet.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to use Rooch faucet

1. Rooch faucet introduction.
2. How to obtain the Rooch's gas.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
13 changes: 13 additions & 0 deletions docs/website/pages/docs/developer-guides/rooch-object.en-US.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Rooch object

1. Rooch object introduction.
2. The difference between the Sui object.
3. How to use the Rooch object.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
13 changes: 13 additions & 0 deletions docs/website/pages/docs/developer-guides/rooch-object.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Rooch object

1. Rooch object introduction.
2. The difference between the Sui object.
3. How to use the Rooch object.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
107 changes: 107 additions & 0 deletions docs/website/pages/docs/example-guides.en-US.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Example guides

Here are all Rooch examples introduction and source code indices.

## Basic object

This example introduces how to use the Rooch object.

### Source code

[`basic_object`](https://github.com/rooch-network/rooch/tree/main/examples/basic_object)

## Blog

This example introduces how to use a low-code tool to develop a blog sample application.

### Source code

[`blog`](https://github.com/rooch-network/rooch/tree/main/examples/blog)

## Borrow reference

### Source code

[`borrow_reference`](https://github.com/rooch-network/rooch/tree/main/examples/borrow_reference)

## Coins

### Source code

[`coins`](https://github.com/rooch-network/rooch/tree/main/examples/coins)

## Complex struct

### Source code

[`complex_struct`](https://github.com/rooch-network/rooch/tree/main/examples/complex_struct)

## Counter

### Source code

[`counter`](https://github.com/rooch-network/rooch/tree/main/examples/counter)

## Entry function arguments old

### Source code

[`entry_function_arguments_old`](https://github.com/rooch-network/rooch/tree/main/examples/entry_function_arguments_old)

## Entry function arguments

### Source code

[`entry_function_arguments`](https://github.com/rooch-network/rooch/tree/main/examples/entry_function_arguments)

## Event

### Source code

[`event`](https://github.com/rooch-network/rooch/tree/main/examples/event)

## KV store

### Source code

[`kv_store`](https://github.com/rooch-network/rooch/tree/main/examples/kv_store)

## Module init

### Source code

[`module_init`](https://github.com/rooch-network/rooch/tree/main/examples/module_init)

## Noop auth validator

### Source code

[`noop_auth_validator`](https://github.com/rooch-network/rooch/tree/main/examples/noop_auth_validator)

## Private generics

### Source code

[`private_generics`](https://github.com/rooch-network/rooch/tree/main/examples/private_generics)

### References

[Read private generic functions in one article](https://rooch.network/blog/read-private-generics-in-one-article)

## Publish modules

### Source code

[`publish_modules`](https://github.com/rooch-network/rooch/tree/main/examples/publish_modules)

## Simple blog

### Source code

[`simple_blog`](https://github.com/rooch-network/rooch/tree/main/examples/simple_blog)

## Steal split

### Source code

[`steal_split`](https://github.com/rooch-network/rooch/tree/main/examples/steal_split)
107 changes: 107 additions & 0 deletions docs/website/pages/docs/example-guides.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Example guides

Here are all Rooch examples introduction and source code indices.

## Basic object

This example introduces how to use the Rooch object.

### Source code

[`basic_object`](https://github.com/rooch-network/rooch/tree/main/examples/basic_object)

## Blog

This example introduces how to use a low-code tool to develop a blog sample application.

### Source code

[`blog`](https://github.com/rooch-network/rooch/tree/main/examples/blog)

## Borrow reference

### Source code

[`borrow_reference`](https://github.com/rooch-network/rooch/tree/main/examples/borrow_reference)

## Coins

### Source code

[`coins`](https://github.com/rooch-network/rooch/tree/main/examples/coins)

## Complex struct

### Source code

[`complex_struct`](https://github.com/rooch-network/rooch/tree/main/examples/complex_struct)

## Counter

### Source code

[`counter`](https://github.com/rooch-network/rooch/tree/main/examples/counter)

## Entry function arguments old

### Source code

[`entry_function_arguments_old`](https://github.com/rooch-network/rooch/tree/main/examples/entry_function_arguments_old)

## Entry function arguments

### Source code

[`entry_function_arguments`](https://github.com/rooch-network/rooch/tree/main/examples/entry_function_arguments)

## Event

### Source code

[`event`](https://github.com/rooch-network/rooch/tree/main/examples/event)

## KV store

### Source code

[`kv_store`](https://github.com/rooch-network/rooch/tree/main/examples/kv_store)

## Module init

### Source code

[`module_init`](https://github.com/rooch-network/rooch/tree/main/examples/module_init)

## Noop auth validator

### Source code

[`noop_auth_validator`](https://github.com/rooch-network/rooch/tree/main/examples/noop_auth_validator)

## Private generics

### Source code

[`private_generics`](https://github.com/rooch-network/rooch/tree/main/examples/private_generics)

### References

[Read private generic functions in one article](https://rooch.network/blog/read-private-generics-in-one-article)

## Publish modules

### Source code

[`publish_modules`](https://github.com/rooch-network/rooch/tree/main/examples/publish_modules)

## Simple blog

### Source code

[`simple_blog`](https://github.com/rooch-network/rooch/tree/main/examples/simple_blog)

## Steal split

### Source code

[`steal_split`](https://github.com/rooch-network/rooch/tree/main/examples/steal_split)
11 changes: 11 additions & 0 deletions docs/website/pages/docs/miscellaneous/glossary.en-US.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Glossary

1. Add some Rooch-related glossaries.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
11 changes: 11 additions & 0 deletions docs/website/pages/docs/miscellaneous/glossary.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Glossary

1. Add some Rooch-related glossaries.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
8 changes: 8 additions & 0 deletions docs/website/pages/docs/tech-highlights/storage.en-US.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# Global Object and KV Storage

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
8 changes: 8 additions & 0 deletions docs/website/pages/docs/tech-highlights/storage.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# Global Object and KV Storage

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Interact with MetaMask

1. How to connect to Rooch network which MataMask.
2. How to switch network.
3. How to send a tx with MataMask.
4. How to attach and detach a DApp.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Interact with MetaMask

1. How to connect to Rooch network which MataMask.
2. How to switch network.
3. How to send a tx with MataMask.
4. How to attach and detach a DApp.

import { Callout, FileTree } from 'nextra/components'

<Callout>
TODO:

This document is being improved!
</Callout>

0 comments on commit 5aebd8d

Please sign in to comment.