Add Readme Getting Started Markdown

README.md

@@ -29,20 +29,38 @@ Manlink Knowledge Base
 ### VSCode-Git 使用说明
 
 1. 在完成环境部署后，vscode中源代码管理功能应可用，从侧边栏中访问该功能
-   ![VSCode Git](./source/_images/Readme/vscode_git.png)
+   ![VSCode Git](./Readme/img/vscode_git.png)
 2. 想要对知识库页面进行编辑时，需**签出新分支**，参考下图步骤
 
-    ![](./source/_images/Readme/vscode_checkout.png)
-    ![](./source/_images/Readme/vscode_new_branch.png)
+    ![](./Readme/img/vscode_checkout.png)
+    ![](./Readme/img/vscode_new_branch.png)
 
-> **Warning**
+> [!CAUTION]
 > 请不要直接对`master`分支进行修改！
 >修改前请**签出**分支，修改完成后请发起***合并分支***请求
 
 3. 在进行编辑后点击这里进行推送/发布新分支
-   ![](./source/_images/Readme/vscode_push.png)
+   ![](./Readme/img/vscode_push.png)
 
-> **Info**
+> [!NOTE]
+> 
 > 想要更加详细了解Git可以参考[这篇文档](./Readme/git.md)
 
-### 合并修改
+### 添加/修改内容
+
+1. 本知识库采用`Sphinx`作为解析、生成工具，并*推荐*主要以`Markdown`语言作为文档的原始语言格式,`reStructuredText`语言作为辅助
+2. `source`文件夹即为知识库原始文件夹，通过文件树及`index.rst`进行网页层级管理
+
+> [!IMPORTANT]  
+> 请**不要**修改`source/conf.py`其为`Sphinx`配置文件！如需修改请提交PR至管理员
+
+3. 创建文档时：
+   1. 请将图片放入`_images/`目录下，建议单独创建文件夹以保证目录整洁
+   2. 其他数据，如：实验数据、日志等，请放入`_static/`目录下，同样建议创建文件夹以保证目录整洁
+   3. 对于新创建的文档：
+      1. 如已存在对应目录，则仅需在对应目录下创建文档即可，建议保证文件名具有**通俗易懂**的可读性
+      2. 如不存在目录，则需创建目录及`index.rst`，并更新上级的`index.rst`或`index.md`，具体内容可参考已有文档，如[子目录index.rst](./source/Mars_1KS/DC/PPMU/1.0/index.rst)及[父目录index.rst](./source/Mars_1KS/index.rst)之后新建文档
+   
+> [!Note]
+>
+> 对于Markdown语法，可以参考[这篇文档](./Readme/markdown.md)