mirror of
https://github.com/sipeed/sipeed_wiki.git
synced 2026-09-11 00:22:49 -05:00
update contribute_doc_zh
This commit is contained in:
@@ -1,29 +1,43 @@
|
||||
# 编辑文档
|
||||
|
||||
现在的文档仓库数量庞大,存在着一些编者都没有注意的错误。当读者发现错误的时候,可以进行修改。
|
||||
现在的文档仓库数量庞大,存在着一些编者都没有注意的错误。
|
||||
当读者发现错误的时候,可以进行修改。
|
||||
|
||||
- 进入需要修改的文档页面,点击 “编辑本页”
|
||||
这里是直接链接到存放 wiki 源码的 GitHub 仓库(进入比较慢或者404 的时候,需要挂上代理)
|
||||
## 定位文件
|
||||
|
||||

|
||||
进入需要修改的文档页面,点击 “编辑本页”
|
||||
|
||||
- 登录 GitHub 账号
|
||||
在右上角进行 GitHub 账号登录/注册操作
|
||||

|
||||
|
||||

|
||||
就会跳转到想要修改页面所在的 github 原文件位置。~~github 上不去的话很正常~~
|
||||
|
||||
- 修改文档
|
||||
点击文本框中的 编辑 图标,就会直接对 源码 进行修改,这里使用的 markdown 进行编写的,如果不是知道如何使用 markdown ,请自行百度教程。
|
||||

|
||||
|
||||

|
||||
## 登录 github
|
||||
|
||||
编辑框为以下形式,文档中图片为连接位置尽量不要使用外链,如需使用,提交pr的注明一下,会由管理员统一同步到仓库中
|
||||
点击 github 页面右上角的 `sign in` 来登陆账号
|
||||
|
||||

|
||||

|
||||
|
||||
- 提交 PR
|
||||
文档修改结束之后,在编辑框下进行提交。根据提示填入修改备注信息
|
||||
## 修改文档
|
||||
|
||||

|
||||

|
||||
|
||||
仓库管理员看到之后,会在确认可用之后合并到仓库中。
|
||||
点击上图所框出的图标来编辑当前文件,就相当于直接对 wiki 网页编辑了。
|
||||
文件主要以 markdown 为主,少部分为 ipynb 。
|
||||
|
||||
编辑页面如下所示,其中两个红框分别是 编辑文件 页面和 预览 页面。编辑时可以随时切换到预览页面来查看一下编辑结果
|
||||
|
||||

|
||||
|
||||
## 提交
|
||||
|
||||
文档修改完毕后,在编辑框最底下进行提交。
|
||||
可以在红框中简述修改信息,并且在蓝框中补充说明。
|
||||
也可以不进行说明直接点下方的绿色的 'Commit Changes'来进行提交
|
||||
|
||||

|
||||
|
||||
仓库管理员看到之后,会在确认可用之后合并到仓库中。
|
||||
|
||||
> 感谢参与建设开源文档
|
||||
Reference in New Issue
Block a user