Main

.github/workflows/publish.yaml

@@ -11,21 +11,26 @@ on:
 
 jobs:
   build-and-deploy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2 
         with:
           persist-credentials: false
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
       - name: Install and Build 
         run: |
           npm install
-          npm run predownload
-          npm run docs:build
+          make build
+
       - name: Deploy 
         uses: JamesIves/github-pages-deploy-action@releases/v3
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages
-          FOLDER: docs/.vuepress/dist 
+          FOLDER: docs/.vuepress/dist 

Makefile

@@ -1,9 +1,7 @@
+build:
+	npm run predownload
+	npm run docs:build
+
 dev:
 	npm run predownload
 	npm run docs:dev
-
-docker-buildenv:
-	docker build --build-arg https_proxy=$(BUILD_DOCKER_PROXY) -t filvenus/venus-buildenv -f script/docker/venus-buildenv.dockerfile .
-
-docker-runtime:
-	docker build --build-arg https_proxy=$(BUILD_DOCKER_PROXY) -t filvenus/venus-runtime -f script/docker/venus-runtime.dockerfile .

README.md

@@ -40,5 +40,3 @@ The Filecoin Project's software code is dual-licensed under Apache 2.0 and MIT t
 Documentation and other written content is copyright (c) Protocol Labs under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license.
 
 See the [LICENSE.md](LICENSE.md) file for details.
-
-

docs/.vuepress/config.js

@@ -21,6 +21,7 @@ module.exports = {
         '@vuepress/nprogress',
         '@vuepress/medium-zoom',
         '@vuepress-plugin-zooming',
+        'fulltext-search',
         ['vuepress-plugin-code-copy', true]
     ],
     head: [
@@ -81,8 +82,12 @@ module.exports = {
                     link: '/intro/'
                 },
                 {
-                    text: 'Reference',
-                    link: '/ref/'
+                    text: 'Deployment & Operation',
+                    link: '/operation/'
+                },
+                {
+                    text: 'Developer',
+                    link: '/developer/'
                 },
                 {
                     text: 'About',
@@ -97,14 +102,36 @@ module.exports = {
                             ['', 'Overview'],
                         ]
                     },
+                    ],
+                    '/operation/': [
                     {
                         title: 'Deployment',
                         collapsable: false,
                         children: [
+                            ['', 'Before deployment'],
                             ['deploy-a-cs.md', 'Deploy a Sophon service'],
                             ['join-a-cs.md', 'Use a Sophon service'],
                         ]
                     },
+                    {
+                        title: 'Sophon Components',
+                        collapsable: false,
+                        children: [
+                            ['venus-daemon.md', 'venus daemon'],
+                            ['venus-auth.md', 'venus-auth', "https://github.com/ipfs-force-community/sophon-auth/blob/master/docs/en/getting-started.md"],
+                            ['venus-miner.md', 'venus-miner', "https://github.com/ipfs-force-community/sophon-miner/blob/master/docs/en/config-desc.md"],
+                            ['venus-messager.md', 'venus-messager', "https://github.com/ipfs-force-community/sophon-messager/blob/master/docs/en/getting-started.md"],
+                            ['venus-gateway.md', 'venus-gateway', "https://github.com/ipfs-force-community/sophon-gateway/blob/master/docs/en/getting-started.md"],
+                        ]
+                    },
+                    {
+                        title: 'Optional Components',
+                        collapsable: false,
+                        children: [
+                            ['venus-wallet-builtin.md', 'venus-wallet (builtin)', "https://github.com/filecoin-project/venus-wallet/blob/master/docs/en/getting-started-local.md"],
+                            ['venus-wallet.md', 'venus-wallet (remote)', "https://github.com/filecoin-project/venus-wallet/blob/master/docs/en/getting-started-remote.md"],
+                        ]
+                    },
                     {
                         title: 'Operations',
                         collapsable: false,
@@ -115,46 +142,36 @@ module.exports = {
                         ]
                     },
                     ],
-                    '/ref/': [{
-                        title: 'Sophon Components',
+                    '/developer/': [{
+                        title: 'Development',
                         collapsable: false,
                         children: [
-                            ['', 'venus daemon'],
-                            ['venus-auth.md', 'venus-auth'],
-                            ['venus-miner.md', 'venus-miner'],
-                            ['venus-messager.md', 'venus-messager'],
-                            ['venus-gateway.md', 'venus-gateway'],
+                            ['', 'Setup local 2k Env'],
                         ]
                     },
                     {
-                        title: 'Optional Components',
+                        title: 'RPC reference',
                         collapsable: false,
                         children: [
-                            ['venus-wallet-builtin.md', 'venus-wallet (builtin)'],
-                            ['venus-wallet.md', 'venus-wallet (remote)'],
+                            ['', 'Setup local 2k Env'],
                         ]
                     },
-                    {
-                        title: 'RPC API Reference',
+                    ],
+                    '/about/': [{
+                        title: '',
                         collapsable: false,
                         children: [
                             ['chain-api-v0.md', 'Chain api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/chain/v0/method.md"],
                             ['chain-api-v1.md', 'Chain api v1', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/chain/v1/method.md"],
+                            ['messager-api.md', 'Messager api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/messager/method.md"],
                             ['gateway-api-v0.md', 'Gateway api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/gateway/v0/method.md"],
                             ['gateway-api-v1.md', 'Gateway api v1', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/gateway/v1/method.md"],
-                            ['messager-api.md', 'Messager api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/messager/method.md"],
+                            ['market-api-v0.md', 'Market api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/market/v0/method.md"],
+                            ['market-api-v1.md', 'Market api v1', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/market/v1/method.md"],
                             ['wallet-api.md', 'Wallet api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/wallet/method.md"]
                         ]
                     },
                     ],
-                    '/about/': [{
-                        title: '',
-                        collapsable: false,
-                        children: [
-                            ['', 'About Us'],
-                        ]
-                    },
-                    ],
                 }
             },
             '/zh/': {
@@ -164,12 +181,16 @@ module.exports = {
                 description: '智子（原Venus链服务）是一个Filecoin超级节点解决方案',
                 nav: [
                 {
-                    text: '介绍',
+                    text: '功能介绍',
                     link: '/zh/intro/'
                 },
                 {
-                    text: '参考',
-                    link: '/zh/ref/'
+                    text: '部署/运维',
+                    link: '/zh/operation/'
+                },
+                {
+                    text: '研发/设计',
+                    link: '/zh/developer/'
                 },
                 {
                     text: '关于',
@@ -178,25 +199,52 @@ module.exports = {
                 ],
                 sidebar: {
                     '/zh/intro/': [{
-                        title: '简述',
+                        title: '功能特性',
                         collapsable: false,
                         children: [
                             ['', '概要'],
                         ]
                     },
+                    ],
+                    '/zh/operation/': [
                     {
                         title: '部署',
                         collapsable: false,
                         children: [
+                            ['', '部署前准备'],
                             ['deploy-a-cs.md', '部署智子服务'],
+                            ['venus-run-in-docker.md', '使用 Docker 部署智子服务'],
                             ['join-a-cs.md', '使用智子服务'],
                         ]
                     },
                     {
-                        title: '简易部署',
+                        title: '智子服务组件',
+                        collapsable: false,
+                        children: [
+                            ['venus-daemon.md', 'venus daemon'],
+                            ['sophon-auth.md', 'sophon-auth', "https://github.com/ipfs-force-community/sophon-auth/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B.md"],
+                            ['sophon-miner.md', 'sophon-miner', "https://github.com/ipfs-force-community/sophon-miner/blob/master/docs/zh/getting-start.md"],
+                            ['sophon-messager.md', 'sophon-messager', "https://github.com/ipfs-force-community/sophon-messager/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B.md"],
+                            ['sophon-gateway.md', 'sophon-gateway', "https://github.com/ipfs-force-community/venus-gateway/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E5%90%AF%E7%94%A8.md"],
+                        ]
+                    },
+                    {
+                        title: '配置文件',
+                        collapsable: false,
+                        children: [
+                            ['sophon-auth-config.md', 'sophon-auth', "https://github.com/ipfs-force-community/sophon-auth/blob/master/docs/zh/config-desc.md"],
+                            ['sophon-miner-config.md', 'sophon-miner', "https://github.com/ipfs-force-community/sophon-miner/blob/master/docs/zh/config-desc.md"],
+                            ['sophon-messager-config.md', 'sophon-messager', "https://github.com/ipfs-force-community/sophon-messager/blob/master/docs/zh/config-desc.md"],
+                            ['sophon-gateway-config.md', 'sophon-gateway', "https://github.com/ipfs-force-community/sophon-gateway/blob/master/docs/zh/config-desc.md"],
+                        ]
+                    },
+                    {
+                        title: 'Wallet',
                         collapsable: false,
                         children: [
-                            ['venus-run-in-docker.md', '使用Docker部署智子服务'],
+                            ['venus-wallet-builtin.md', 'venus wallet（内置）', "https://github.com/filecoin-project/venus-wallet/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B%5B%E6%9C%AC%E5%9C%B0%5D.md"],
+                            ['venus-wallet.md', 'venus-wallet（远程）', "https://github.com/filecoin-project/venus-wallet/blob/master/docs/zh/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B%5B%E8%BF%9C%E7%A8%8B%5D.md"],
+                            ['venus-wallet-signfilter.md', 'venus-wallet 签名过滤器', "https://github.com/filecoin-project/venus-wallet/blob/master/docs/zh/%E8%AE%A2%E5%8D%95%E8%BF%87%E6%BB%A4%E5%99%A8.md"],
                         ]
                     },
                     {
@@ -209,41 +257,37 @@ module.exports = {
                         ]
                     },
                     ],
-                    '/zh/ref/': [{
-                        title: '智子服务组件',
+                    '/zh/developer/': [{
+                        title: '研发',
                         collapsable: false,
                         children: [
-                            ['', 'Venus daemon'],
-                            ['venus-auth.md', 'venus-auth'],
-                            ['venus-miner.md', 'venus-miner'],
-                            ['venus-messager.md', 'venus-messager'],
-                            ['venus-gateway.md', 'venus-gateway'],
+                            ['', '本地2k开发网络'],
                         ]
                     },
                     {
-                        title: '可选组件',
+                        title: '智子组件设计',
                         collapsable: false,
                         children: [
-                            ['venus-wallet-builtin.md', 'venus-wallet（内置）'],
-                            ['venus-wallet.md', 'venus-wallet（远程）'],
+                            ['miner-design.md', 'miner 设计', "https://github.com/ipfs-force-community/sophon-miner/blob/master/docs/zh/design-spec.md"],
+                            ['messager-design.md', 'messager 设计', "https://github.com/ipfs-force-community/sophon-messager/blob/master/docs/zh/design-specs.md"],
+                            ['gateway-design.md', 'gateway 设计', "https://github.com/ipfs-force-community/venus-gateway/blob/master/docs/zh/%E7%BB%84%E4%BB%B6%E8%AE%BE%E8%AE%A1.md"],
                         ]
                     },
                     {
-                        title: '组件构建',
+                        title: '功能设计',
                         collapsable: false,
                         children: [
-                            ['build.md', '全组件构建'],
+                            ['data-by-id.md', '用户数据隔离'],
                         ]
                     },
                     {
                         title: 'RPC 接口参考',
                         collapsable: false,
                         children: [
-                            ['chain-api-v0.md', 'Chain api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/chain/v0/method.md"],
                             ['chain-api-v1.md', 'Chain api v1', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/chain/v1/method.md"],
-                            ['gateway-api-v0.md', 'Gateway api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/gateway/v0/method.md"],
+                            ['chain-api-v0.md', 'Chain api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/chain/v0/method.md"],
                             ['gateway-api-v1.md', 'Gateway api v1', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/gateway/v1/method.md"],
-                            ['market-api.md', 'Market api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/market/method.md"],
+                            ['gateway-api-v0.md', 'Gateway api v0', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/gateway/v0/method.md"],
                             ['messager-api.md', 'Messager api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/messager/method.md"],
                             ['wallet-api.md', 'Wallet api', "https://github.com/filecoin-project/venus/blob/master/venus-shared/api/wallet/method.md"]
                         ]

docs/about/README.md

@@ -15,6 +15,6 @@
 
 - venus-docs: [venus.filecoin.io](venus.filecoin.io)
 - VenusHub: [venushub.io](venushub.io)
-- Github: [venus](https://github.com/filecoin-project/venus)
+- Github: [venus](https://github.com/filecoin-project/venus), [sophon-messager](https://github.com/ipfs-force-community/sophon-messager), [sophon-auth](https://github.com/ipfs-force-community/sophon-auth), [sophon-gateway](https://github.com/ipfs-force-community/sophon-gateway), [sophon-miner](https://github.com/ipfs-force-community/sophon-miner), [sophon-co](https://github.com/ipfs-force-community/sophon-co), [damocles](https://github.com/ipfs-force-community/damocles), [droplet](https://github.com/ipfs-force-community/droplet)
 - Social Media: [Twitter](https://twitter.com/venus_filecoin), [Wechat](https://mp.weixin.qq.com/s/p4_ch03QeMMXxPyakr_8XQ)
 - Security audit report: [link](https://leastauthority.com/static/publications/LeastAuthority_Filecoin_Foundation_Venus_Final_Audit_Report.pdf)