From 92ca4c948167f0c4b1e4c5703e64aa4401a86896 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E5=A9=B7=E5=A9=B7?= Date: Fri, 19 Jun 2020 21:55:11 +0800 Subject: [PATCH] update contribute guide --- docs/src/contribute.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/src/contribute.md b/docs/src/contribute.md index 205d863f1..0ee42ce65 100644 --- a/docs/src/contribute.md +++ b/docs/src/contribute.md @@ -1,7 +1,6 @@ # Contribute -Follow these steps to contribute to this book! - +Follow these steps to contribute to this book! We use an utility tool called mdBook to create online books from Markdown files. @@ -18,7 +17,13 @@ We use an utility tool called mdBook to create online books from Markdown files. ## Build and Deploy -1. `mdbook build` -2. `make publish-book` +The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nim-beacon-chain/tree/devel). +Then, after it is merged, do the following under our main repository: + +1. `cd nim-beacon-chain` +2. `git checkout devel` +3. `git pull` +4. `make update` (This is to update the submodules to the latest version) +5. `make publish-book` Thank you so much for your help to the decentralized and open source community. :)