Skip to content

Commit

Permalink
Add check links health (#163)
Browse files Browse the repository at this point in the history
* add check link health bot
  • Loading branch information
geometryolife authored Aug 3, 2022
1 parent 10da74e commit fe1ee18
Show file tree
Hide file tree
Showing 34 changed files with 119 additions and 50 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/check-link.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Check Markdown links
on: push
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
# @See https://github.com/gaurav-nelson/github-action-markdown-link-check
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
2 changes: 1 addition & 1 deletion docs/01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ It contains three main sections.

These learning resources are mainly related to Starcoin, but they can also be used as general learning resources for blockchain and smart contracts, because the smart contract blockchains are similar in technical principles.

This document is still being improved, and welcome to improve it [Contribution Guide](./miscellaneous/contributing).
This document is still being improved, and welcome to improve it [Contribution Guide](./100-miscellaneous/99-contributing.md).
6 changes: 3 additions & 3 deletions docs/02-getting-started/01-install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
This article guides you on how to install starcoin.

1. Download the binary for your operating system from Github's [releases](https://github.com/starcoinorg/starcoin/releases) page. Starcoin supports Windows/Mac/Linux, unzip the binary and put it into the system bin path.
2. Or [build from source](./build).
3. Or [install by docker](./install-by-docker).
4. Or [install by homebrew for macOS](./install-by-homebrew)
2. Or [build from source](./01-build.md).
3. Or [install by docker](./02-install-by-docker.md).
4. Or [install by homebrew for macOS](./03-install-by-homebrew.md)


:::note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Starcoin node has a built-in decentralized wallet that allows users to manage their accounts through account api and commands.

When the node starts, a default account is automatically created with an empty password. The default account can be changed via account commands.
The following commands require a connection to the console, see [How working with the Starcoin console](../setup/starcoin-console).
The following commands require a connection to the console, see [How working with the Starcoin console](../02-setup/02-starcoin-console.md).

1. Create account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Let's say you've run up a Starcoin dev node locally.

## A few steps to submit a transaction

- Start the Starcoin CLI console and connect to the Starcoin node,detail document at [How working with the Starcoin console](../setup/starcoin-console).
- Create two accounts: Alice and Bob, detail step see [Manage account by CLI](../accounts/account-manage).
- Start the Starcoin CLI console and connect to the Starcoin node,detail document at [How working with the Starcoin console](../02-setup/02-starcoin-console.md).
- Create two accounts: Alice and Bob, detail step see [Manage account by CLI](./01-account-manage.md).
- Mint money into Alice's account.
- Submit transfer transaction: Alice send money to Bob.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Multisig accounts and multisig transactions

[Account concept](../../concepts/account)
[Account concept](../../99-concepts/01-account.md)

This section describes the use of multisig accounts, including how to create multisig accounts on-chain via the CLI, and how to initiate multisig transactions. For the principle and implementation of multi-signature accounts, please refer to the multi-signature account section of the [account concept](../../concepts/account).
This section describes the use of multisig accounts, including how to create multisig accounts on-chain via the CLI, and how to initiate multisig transactions.
For the principle and implementation of multi-signature accounts, please refer to the multi-signature account section of the [account concept](../../99-concepts/01-account.md).

## Pre-preparation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Usage scenarios.

## Preparation

Start a `starcoin` dev node and connect it. See [Using the starcoin console](../setup/starcoin-usage) .) for detailed steps. .
Start a `starcoin` dev node and connect it. See [Using the starcoin console](../02-setup/02-starcoin-console.md) for detailed steps.

## Steps

Expand Down
10 changes: 5 additions & 5 deletions docs/03-move/02-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prepare in advance:

1. You need to build a *dev* network according to [how to set up a local development network](../02-getting-started/02-setup/03-dev-network.md) and connect to the *dev* network through the Starcoin console.

2. Create an account according to [account management](../02-getting-started/03-accounts/1.account-manage.md) or use an existing account, and transfer a little STC to the account.
2. Create an account according to [account management](../02-getting-started/03-accounts/01-account-manage.md) or use an existing account, and transfer a little STC to the account.

3. There is a basic understanding of the *transaction* through [the first on-chain transaction](../02-getting-started/03-accounts/2.first-transaction.md).
3. There is a basic understanding of the *transaction* through [the first on-chain transaction](../02-getting-started/03-accounts/02-first-transaction.md).

Next, we will introduce some necessary tools and project structure.

Expand Down Expand Up @@ -622,13 +622,13 @@ The complete code repository is [here](https://github.com/starcoinorg/starcoin-c
Next,
* You can systematically learn the Move language through the [Move language](./move-language/)
* You can systematically learn the Move language through the [Move language](./03-move-language/README.md)
* View [more Move examples]
* Learn [how to Debug/test Move module](./97-move-test/01-move-unit-test.md)
* Learn about the [Starcoin Move Framework](./starcoin-framework/)
* Learn about the [Starcoin Move Framework](./06-starcoin-framework/README.md)
* Advanced Move can be learned through [Move Advanced Development].
* Learn about the [Move specification language and Move Prover](./100-move-prover/01-move-spec-language.md) to develop safer Move applications
* Explore more features of [Move Package Manager](./05-move-package-manager.md)
Or you can directly enter the world of Dapp.
* [Web3 and DApp develop](../web3/)
* [Web3 and DApp develop](../04-web3/README.md)
1 change: 1 addition & 0 deletions docs/03-move/100-move-prover/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move prover
1 change: 1 addition & 0 deletions docs/03-move/97-move-test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move test
1 change: 1 addition & 0 deletions docs/03-move/98-move-examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move examples
1 change: 1 addition & 0 deletions docs/03-move/99-advance-move/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Advanced Move
2 changes: 1 addition & 1 deletion docs/04-web3/01-starmask/03-rpc-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ starcoin
#### Encrypting

The point of the encryption key is of course to encrypt things.
Here's an example of how to encrypt a message using [`eth-sig-util`](https://github.com/StarMask/eth-sig-util):
<!-- Here's an example of how to encrypt a message using [`eth-sig-util`](https://github.com/StarMask/eth-sig-util): -->

```javascript
const stcUtil = require("@starcoin/stc-util");
Expand Down
3 changes: 2 additions & 1 deletion docs/04-web3/05-understanding-resource-and-bcs/01-bcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ In the context of a cryptographic application, canonical serialization has sever

Note that BCS ensures canonical serialization for each data type separately. The data type of a serialized value
must be enforced by the application itself. This requirement is typically fulfilled
using unique hash seeds for each data type. (See [Diem's cryptographic library](https://github.com/diem/diem/blob/master/crypto/crypto/src/hash.rs) for an example.)
using unique hash seeds for each data type.
<!-- (See [Diem's cryptographic library](https://github.com/diem/diem/blob/master/crypto/crypto/src/hash.rs) for an example.) -->

## Backwards Compatibility

Expand Down
22 changes: 13 additions & 9 deletions docs/04-web3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ Next, we’ll explore further about each concept we have learned in figure 2. If

It’s an easy decentralized application, it’s designed for you to get started. You will get a quick feel of what Dapp is and how it interacts with Starcoin. For a developer, you can build your own Dapp or check the code structure through viewing its source code.

- Test Dapp Link: https://starmask-test-dapp.starcoin.org/Github
- Test Dapp Link: https://starmask-test-dapp.starcoin.org/
- Github Link: https://github.com/starcoinorg/starmask-test-dapp

## StarMask

Starmask is not only used to manage your digital assets, but another way to interact with Starcoin blockchain. Here is one example, users create digital signature for each transaction in Dapp, then submit this transaction to Txpool which in remote nodes.

- Installation Link: https://github.com/starcoinorg/starmask-extension/blob/main/docs/how-to-install.md
- Installation Link: https://github.com/starcoinorg/starmask-extension/blob/main/docs/en/how-to-install.md
- User Guides Link:https://github.com/starcoinorg/starmask-extension/blob/main/docs/en/how-to-use.md

## SDK
Expand Down Expand Up @@ -125,14 +125,15 @@ You can interact with Starcoin nodes using StarMask or SDK on Starcoin blockchai
If you are a developer and want to get more details about Starcoin. We recommend you check these links:

- Key concept: https://starcoin.org/zh/developer/key_concepts/
- SIPs: https://starcoin.org/zh/developer/sips/
<!-- - SIPs: https://starcoin.org/zh/developer/sips/ -->
- Source code: https://github.com/starcoinorg/starcoin

## Move

Currently, Starcoin is the first one public blockchain that can run Move smart contracts.

1. [Move Book](https://move-book.com/).Check [Move introduction](https://developers.diem.com/docs/move/move-start-here/move-introduction) to learn more about Move.
1. [Move Book](https://move-book.com/).
<!-- Check [Move introduction](https://developers.diem.com/docs/move/move-start-here/move-introduction) to learn more about Move. -->
2. IDE

- Starcoin IDE: https://marketplace.visualstudio.com/items?itemName=starcoinorg.starcoin-ide
Expand All @@ -141,10 +142,10 @@ Currently, Starcoin is the first one public blockchain that can run Move smart c
3. Test
You can test your Move smart contracts with different test types.

- Unit test: [Guides](https://github.com/diem/diem/blob/main/language/changes/4-unit-testing.md)
<!-- - Unit test: [Guides](https://github.com/diem/diem/blob/main/language/changes/4-unit-testing.md) -->
- Functional Test: To run a functional test, make sure to initialize Starcoin first.
- [Guides](https://starcoin.org/zh/developer/functional_test/functional_test/)
- [Examples](https://github.com/starcoinorg/starcoin/tree/master/vm/functional-tests/tests/testsuite)
<!-- - [Examples](https://github.com/starcoinorg/starcoin/tree/master/vm/functional-tests/tests/testsuite) -->

4. Compile and Deploy
There are multiple ways to compile and deploy Move smart contracts on Starcoin blockchain. Make sure that you have chosen appropriate networks!
Expand All @@ -157,7 +158,9 @@ Currently, Starcoin is the first one public blockchain that can run Move smart c

## Stdlib and Protocols

Starcoin has been created using Move language, it also has Stdlib features. Please check our [source code](https://github.com/starcoinorg/starcoin/tree/master/vm/stdlib/modules).Starcoin has defined variety protocols in Stdlib, some protocols will be shown in figure 3.
Starcoin has been created using Move language, it also has Stdlib features. Please check our [source code]
<!-- (https://github.com/starcoinorg/starcoin/tree/master/vm/stdlib/modules). -->
Starcoin has defined variety protocols in Stdlib, some protocols will be shown in figure 3.
![](../../static/img/dapp/pb.jpg)

1. DAO protocolDAO
Expand All @@ -178,12 +181,13 @@ Starcoin has been created using Move language, it also has Stdlib features. Plea
2. Faucet
You will need STC(native cryptocurrency of this platform) when you run tests, such as paying gas fees. As a developer, you can apply for STC in Barnad network.

- Barnad: https://faucet.starcoin.org/barnard
- Barnad: https://faucet.starcoin.org
<!-- - Barnad: https://faucet.starcoin.org/barnard -->

3. Explorer
Explorer is a complementary tool to chain. We suggest that you use [stcscan](https://stcscan.io/) as blockchain explorer.

4. Voting DappVoting Dapp is another developer tool,it’s used to manage Starcoin blockchain. A developer can create a proposal, we will take a public,equal and formal vote in our community on the Voting Dapp. Your proposal will be approved with more votes in favour.

5. Starcoin logos and icons
Download Link: https://starcoin.org/downloads/logo.zip
<!-- Download Link: https://starcoin.org/downloads/logo.zip -->
1 change: 1 addition & 0 deletions docs/99-concepts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Concepts
32 changes: 32 additions & 0 deletions i18n/zh/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -241,5 +241,37 @@
"cmfcmf/d-s-l.searchBar.noResults": {
"message": "无搜索结果",
"description": "message shown if no results are found"
},
"theme.admonition.note": {
"message": "备注",
"description": "The default label used for the Note admonition (:::note)"
},
"theme.admonition.tip": {
"message": "提示",
"description": "The default label used for the Tip admonition (:::tip)"
},
"theme.admonition.danger": {
"message": "危险",
"description": "The default label used for the Danger admonition (:::danger)"
},
"theme.admonition.info": {
"message": "信息",
"description": "The default label used for the Info admonition (:::info)"
},
"theme.admonition.caution": {
"message": "警告",
"description": "The default label used for the Caution admonition (:::caution)"
},
"theme.docs.breadcrumbs.home": {
"message": "主页面",
"description": "The ARIA label for the home page in the breadcrumbs"
},
"theme.docs.breadcrumbs.navAriaLabel": {
"message": "页面路径",
"description": "The ARIA label for the breadcrumbs"
},
"theme.CodeBlock.wordWrapToggle": {
"message": "切换自动换行",
"description": "The title attribute for toggle word wrapping button of code block lines"
}
}
2 changes: 1 addition & 1 deletion i18n/zh/docusaurus-plugin-content-docs/current/01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Starcoin Cookbook 的目标是提供一个全栈的学习资料,方便开发

这些学习材料主要和 Starcoin 相关,但也可以作为区块链和智能合约的通用学习材料,因为主要的智能合约区块链在技术原理上是相通的。

本文档还在完善中,欢迎一起改进,参看[贡献指南](./miscellaneous/contributing)
本文档还在完善中,欢迎一起改进,参看[贡献指南](./100-miscellaneous/99-contributing.md)
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
这篇文章指导你如何安装 starcoin。

1. 从 github 的 [releases](https://github.com/starcoinorg/starcoin/releases) 页面下载适合自己操作系统的二进制,starcoin 同时支持 Windows、Mac 和 Linux, 将解压后将二进制放入系统命令路径中。
2. 或者 [从源码构建](./build)
3. 或者 [通过 Docker 安装](./install-by-docker)
4. 或者 [通过 Homebrew 安装](./install-by-homebrew)
2. 或者 [从源码构建](./01-build.md)
3. 或者 [通过 Docker 安装](./02-install-by-docker.md)
4. 或者 [通过 Homebrew 安装](./03-install-by-homebrew.md)


:::note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Starcoin 节点内置了一个去中心化的钱包,用户可以通过账号

节点启动的时候,会自动创建一个默认账户,默认密码为空。
默认账户可以通过账户相关的命令进行变更。
以下命令需要连接到控制台进行操作,连接方式请参看[如何与 Starcoin 控制台交互](../setup/starcoin-console)
以下命令需要连接到控制台进行操作,连接方式请参看[如何与 Starcoin 控制台交互](../02-setup/02-starcoin-console.md)

1. 创建账户

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

## 提交交易的几个步骤

- 启动 Starcoin 控制台,并连接到 Starcoin 节点,详细步骤请查阅[如何与 Starcoin 控制台交互](../setup/starcoin-console)
- 创建两个账户:Alice 和 Bob,详细步骤请查阅[账号管理](./account-manage)
- 启动 Starcoin 控制台,并连接到 Starcoin 节点,详细步骤请查阅[如何与 Starcoin 控制台交互](../02-setup/02-starcoin-console.md)
- 创建两个账户:Alice 和 Bob,详细步骤请查阅[账号管理](./01-account-manage.md)
- 给 Alice 账户充钱。
- 提交转账交易:Alice 给 Bob 打钱。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 多签账户和多签交易

本节介绍多签账户的使用,包括如何通过 CLI 在链上创建多签账户,以及如何发起多签交易。
关于多签账户的原理和实现请参看[账户](../../concepts/account)概念的多签账户部分。
关于多签账户的原理和实现请参看[账户](../../99-concepts/01-account.md)概念的多签账户部分。

## 前置准备

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

## 准备工作

1. 启动一个 `starcoin` dev 节点并连接。详细步骤请查阅[使用 starcoin 控制台](../setup/starcoin-usage)
1. 启动一个 `starcoin` dev 节点并连接。详细步骤请查阅[使用 starcoin 控制台](../02-setup/02-starcoin-console.md)

## 操作步骤

Expand Down Expand Up @@ -320,4 +320,4 @@ starcoin% account show 0x19b757b48a015ee035c03d01254d977d

### 重置一般账户为多签账户

TODO [多签重构](https://github.com/starcoinorg/starcoin/issues/3411)完成后补充
TODO [多签重构](https://github.com/starcoinorg/starcoin/issues/3411)完成后补充
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
提前准备:

1. 需要按照[如何设置本地开发网络](../02-getting-started/02-setup/03-dev-network.md)搭建 *dev* 网络,并通过 Starcoin 控制台连接到 *dev* 网络。
2. 按照[账号管理](../02-getting-started/03-accounts/1.account-manage.md)创建一个账号或者使用已有账号,并且给账号里转一点 STC。
3. 通过[第一笔链上交易](../02-getting-started/03-accounts/2.first-transaction.md)*交易*有基本的理解。
2. 按照[账号管理](../02-getting-started/03-accounts/01-account-manage.md)创建一个账号或者使用已有账号,并且给账号里转一点 STC。
3. 通过[第一笔链上交易](../02-getting-started/03-accounts/02-first-transaction.md)*交易*有基本的理解。

接下来将介绍一些必备工具和项目结构。

Expand Down Expand Up @@ -598,13 +598,13 @@ starcoin% account execute-function --function <0x地址>::<模块>::<函数> --
完整的代码仓库在[这里](https://github.com/starcoinorg/starcoin-cookbook/tree/main/examples/my-counter)。
接下来,
* 你可以通过 [Move 语言](./move-language/)来系统地学习 Move 语言
* 你可以通过 [Move 语言](./03-move-language/README.md)来系统地学习 Move 语言
* 查看[更多 Move 例子]
* 了解[如何 Debug/测试 Move module](./97-move-test/01-move-unit-test.md)
* 了解 [Starcoin Move Framework](./starcoin-framework/)
* 了解 [Starcoin Move Framework](./06-starcoin-framework/README.md)
* 可以通过 [Move 高级开发]学习高级 Move。
* 了解 [Move 规范语言 和 Move Prover](./100-move-prover/01-move-spec-language.md) 开发更安全的 Move 应用
* 探索 [Move 包管理器](./05-move-package-manager.md)的更多功能
或者,你可以直接进入 Dapp 的世界,
* [Web3 和 DApp 开发](../web3/)
* [Web3 和 DApp 开发](../04-web3/README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Starcoin Move Framework

:::note
TODO

1. introduce starcoin Move framework overview

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move prover
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move test
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Move examples
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ BCS 格式保证规范的序列化,这意味着对于任何给定的数据类

请注意,BCS 分别确保每种数据类型的规范序列化。
序列化值的数据类型必须由应用程序本身强制执行。
通常使用每种数据类型的唯一哈希种子来满足此要求。(有关示例,请参见 [Diem 的密码库](https://github.com/diem/diem/blob/master/crypto/crypto/src/hash.rs)。)
通常使用每种数据类型的唯一哈希种子来满足此要求。
<!-- (有关示例,请参见 [Diem 的密码库](https://github.com/diem/diem/blob/master/crypto/crypto/src/hash.rs)。) -->

## 向后兼容性

Expand Down
Loading

0 comments on commit fe1ee18

Please sign in to comment.