Merge pull request #129 from VisActor/docs/docs-update

docs: update document
VisActor · Dec 3, 2024 · edff79d · edff79d
2 parents b108cf1 + e351db9
commit edff79d
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 25 deletions.
diff --git a/docs/assets/contributing/en/3-How to Contribute Documentation.md b/docs/assets/contributing/en/3-How to Contribute Documentation.md
@@ -143,7 +143,7 @@ Common `type` values include docs (documentation, log changes), feat (new featur
 
 Write a short and precise description in English.
 
-Before submitting the commit, we will perform a commit lint check. You can check the specific rules [here](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js).
+Before submitting the commit, we will perform a commit lint check. You can check the specific rules [here](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js).
 
 A common issue is when the upstream (@visactor/vstory) has been updated, which may cause conflicts when submitting a Pull Request. Therefore, before submitting, merge the commits from other developers with your own. Switch to the develop branch using the following code:
 

diff --git a/docs/assets/contributing/en/4-How to Contribute to a Demo.md b/docs/assets/contributing/en/4-How to Contribute to a Demo.md
@@ -158,7 +158,7 @@ Common `type` values include docs (documentation, log changes), feat (new featur
 
 Write a brief and precise description in English before committing.
 
-Before submitting the commit, we will perform commit lint checks. You can check the [lint rules](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js) for details.
+Before submitting the commit, we will perform commit lint checks. You can check the [lint rules](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js) for details.
 
 A common issue is when the remote upstream (@visactor/vstory) has been updated, which may cause conflicts when submitting the Pull Request. Therefore, before submitting, merge the commits from other developers with your own commits. Switch to the develop branch using the following code:
 

diff --git a/docs/assets/contributing/en/5-How to Contribute Code.md b/docs/assets/contributing/en/5-How to Contribute Code.md
@@ -157,7 +157,7 @@ Common `type` values include docs (documentation, log changes), feat (new featur
 
 Write a short and precise description in English.
 
-Before submitting the commit, we will perform a commit lint check. You can check the [lint rules](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js) for more details.
+Before submitting the commit, we will perform a commit lint check. You can check the [lint rules](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js) for more details.
 
 A common issue is when the upstream (@visactor/vstroy) has been updated, which may cause conflicts when submitting a Pull Request. Therefore, before submitting, merge the commits from other developers with your own commits. Switch to the develop branch using the following code:
 

diff --git a/docs/assets/contributing/zh/1-Setting-Up-the-Development-Environment.md b/docs/assets/contributing/zh/1-Setting-Up-the-Development-Environment.md
@@ -93,7 +93,7 @@ $ npm i --global @microsoft/rush
 # 安装依赖
 $ rush update
 # 启动 vstory 的 demo 页
-$ rush start
+$ rush story
 # 启动本地文档站点
 $ rush docs
 
@@ -117,6 +117,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 
 discord：https://discord.com/invite/3wPyxVyH6m
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
diff --git a/docs/assets/contributing/zh/2-Howto Submit an Issue.md b/docs/assets/contributing/zh/2-Howto Submit an Issue.md
@@ -56,6 +56,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 
 discord：https://discord.com/invite/3wPyxVyH6m
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
diff --git a/docs/assets/contributing/zh/3-How to Contribute Documentation.md b/docs/assets/contributing/zh/3-How to Contribute Documentation.md
@@ -172,7 +172,7 @@ VisActor 的 commit 提交信息遵循 [Conventional Commits](https://www.conven
 
 请用简短精确的英文描述编写 description
 
-提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js)。
+提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js)。
 
 一个常见的问题是远程的 upstream (@visactor/vstory) 有了新的更新， 从而会导致我们提交的 Pull Request 时会导致冲突。 因此我们可以在提交前先把远程其他开发者的 commit 和我们的 commit 合并。使用以下代码切换到 develop 分支:
 
@@ -255,6 +255,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 
 discord：https://discord.com/invite/3wPyxVyH6m
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
diff --git a/docs/assets/contributing/zh/4-How to Contribute to a Demo.md b/docs/assets/contributing/zh/4-How to Contribute to a Demo.md
@@ -187,7 +187,7 @@ VisActor 的 commit 提交信息遵循 [Conventional Commits](https://www.conven
 
 请用简短精确的英文描述编写 description
 
-提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js)。
+提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js)。
 
 一个常见的问题是远程的 upstream (@visactor/vstory) 有了新的更新， 从而会导致我们提交的 Pull Request 时会导致冲突。 因此我们可以在提交前先把远程其他开发者的 commit 和我们的 commit 合并。使用以下代码切换到 develop 分支:
 
@@ -273,14 +273,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 
 discord：https://discord.com/invite/3wPyxVyH6m
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
-
-```
-
-```
-
-```
-
-```
diff --git a/docs/assets/contributing/zh/5-How to Contribute Code.md b/docs/assets/contributing/zh/5-How to Contribute Code.md
@@ -157,7 +157,7 @@ VisActor 的 commit 提交信息遵循 [Conventional Commits](https://www.conven
 
 请用简短精确的英文描述编写 description
 
-提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/98711490e90532d896dd9e44dd00a3af5b95f06d/common/autoinstallers/lint/commitlint.config.js)。
+提交 commit 之前，我们会进行 commit lint 检查，具体可以查看[检查规则](https://github.com/VisActor/VStory/blob/develop/common/autoinstallers/lint/commitlint.config.js)。
 
 一个常见的问题是远程的 upstream (@visactor/vstroy) 有了新的更新， 从而会导致我们提交的 Pull Request 时会导致冲突。 因此我们可以在提交前先把远程其他开发者的 commit 和我们的 commit 合并。使用以下代码切换到 develop 分支:
 
@@ -240,6 +240,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 
 discord：https://discord.com/invite/3wPyxVyH6m
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
diff --git a/docs/assets/contributing/zh/6-How to upload image.md b/docs/assets/contributing/zh/6-How to upload image.md
@@ -36,10 +36,6 @@ VisActor 官网：[www.visactor.io/](https://link.juejin.cn/?target=https%3A%2F%
 discord：https://discord.com/invite/3wPyxVyH6m
 
 
-# 本文档由由以下人员贡献
+# 本文档由以下人员贡献
 
 [玄魂](https://github.com/xuanhun)
-
-# 本文档由由以下人员贡献
-
-[玄魂](https://github.com/xuanhun)