:recycle: mint/documents 目录结构调整

README.md

@@ -42,14 +42,6 @@ IAPT = International Academy Of Pali Tipitaka - 国际巴利三藏学院
 - 巴利文献的整理翻译及研究
 - 基于项目培养相关人才，实现产学研一体化发展。
 
-# 参与开发
-
-关注此 [项目看板](https://github.com/orgs/iapt-platform/projects/5)
-
-发现有合适的待领取（To do 状态）任务时，联系 Visuddhinanda(email:visuddhinanda@gmail.com) 加入。
-
-技术细节：暂时请先尝试阅读代码，重构结束后会有补充完整的开发文档。
-
 # 什么是巴利圣典？
 
 巴利圣典乘载着佛陀的教导。
@@ -57,3 +49,14 @@ IAPT = International Academy Of Pali Tipitaka - 国际巴利三藏学院
 从佛陀入灭后一个月开始，五百位阿拉汉僧人作了集结会议，将佛陀所宣说的法完整的背诵了下来，在这2600多年中一共经历了六次的集结会议，将教法传承至今。因主要分为三个部分律藏、经藏、论藏，因此一般也称作巴利三藏。
 
 Pāli 即是圣典的意思，是以古印度语言为基础的文献，目前这种语言已不在于日常被使用，只用于传承佛法，因此也将此语言直接称作巴利语（Pāli language），为了避免混淆，通常在语言翻译上，会将「巴利」（表示语言）和「圣典」（表示典籍）分开，将它称作巴利圣典。
+
+# 参与开发
+
+- 关注 [项目看板](https://github.com/orgs/iapt-platform/projects/5)
+
+    发现有合适的待领取（To do 状态）任务时，可联系 [Visuddhinanda](mailto:visuddhinanda@gmail.com "Email") 加入。
+
+- 阅读 [开发文档](./documents/README.md
+)
+
+    开发文档尚未编写完毕，如有疑问，可参考代码，或联系 [Visuddhinanda](mailto:visuddhinanda@gmail.com "Email") 沟通。

documents/README.md

@@ -0,0 +1,36 @@
+# 关于项目
+
+本项目 wikipāḷi 是巴利圣典教育开放平台（IAPT Platform）的重要构成部分，当前承载着平台所提供的主要能力。
+
+wikipāḷi 的前身是 PCD-Suite，一个使用 PHP + JQuery + SQLite 架构的网页版工具，当前处于试运行环境的服务，就是运行的该版本代码。具体内容参见 [app 目录](../app/
+)。
+
+# 当前任务
+
+当前以解决问题为目标，在最小化成本、保证项目运行不中断的前提下，进行重构。
+
+# 后端文档
+
+参见 [documents/api](./api/) 目录，虽然文档尚未完善，但已包含了几乎所有的数据模型和梳理后的 API 接口。
+
+# 前端文档
+
+参见 [documents/dashboard](./dashboard/) 目录，虽然文档尚未完善，但包含了相对完整的网页地图，可供参考。
+
+# 技术选型
+
+以问题出发，进行技术选型，避免长时间大重构，保证小步推进，逐步替换。
+
+以下为对应问题的技术选型变更：
+
+- 为解决数据库效率问题
+  [x] SQLite 替换为 PostgreSQL
+  
+- 为解决权限模块安全问题
+  [ ] 方案尚未确定
+
+- 为解决编辑器运行效率问题
+  [ ] 方案尚未确定
+
+- 为解决编辑器可扩展问题
+  [ ] 方案尚未确定

documents/zh/api/readme.md → documents/api/README.md

@@ -1,6 +1,11 @@
+# 注意
+
+- 该文档尚未完善，内容仅供参考
+- 该文档中的技术方案尚未敲定，如涉及具体开发，需先行商议
+
 # 后端开发文档
 
-## 开发环境
+## 开发环境（待商议）
 
 -   golang
 -   PostgreSQL
@@ -31,8 +36,8 @@ https://github.com/go-redis/redis
 -   [译文](translation.md)
 -   [文章文集](article.md)
 -   [逐词解析](wbw.md)
--   [全文搜索](search.md)
--   [其他工具表](others.md)
+-   全文搜索
+-   其他工具表
 
 ```mermaid
 graph LR
@@ -64,6 +69,8 @@ collection_edit --> collection
 article_edit  --> article
 ```
 
+[全文搜索]: 
+
 ## 数据表设计
 
 数据表应包含如下字段

documents/zh/dashboard/readme.md → documents/dashboard/README.md

@@ -1,8 +1,13 @@
+# 注意
+
+- 该文档尚未完善，内容仅供参考
+- 该文档中的技术方案尚未敲定，如涉及具体开发，需先行商议
+
 # 说明
 
 本文档是网站页面的前端设计文档
 
-# 开发环境
+# 开发环境（待商议）
 
 -   React
 -   Umijs
@@ -46,9 +51,11 @@ reader -->wbw
 term -->|嵌入| wbw
 ```
 
+> 注意：以下目录内，仅标星（*）项目有具体内容，其余尚未编写
+
 -   藏经阁-Libray
     -   [首页](home.md)
-    -   [三藏](palicanon.md)
+    -   [三藏*](palicanon.md)
     -   [课程](course.md)
     -   [字典](dict.md)
     -   [搜索](search.md)

documents/zh/dashboard/course.md

@@ -1 +0,0 @@
-# 课程栏目前端设计

documents/zh/dashboard/myzone.md

@@ -1 +0,0 @@
-# 个人空间

documents/zh/dashboard/public.md

@@ -1,5 +0,0 @@
-# 公共组件与资源
-
-## 网站导航组件
-
-## 网站页脚组件

documents/zh/db/readme.md

@@ -1,9 +0,0 @@
-# 数据库
-
-## 语料库
-
-## 字典
-
-
-
-

documents/zh/readme.md

@@ -1,19 +0,0 @@
-# wikipali 开发文档
-
-## 概述
-## 价值观
-- **可重用的数据** 从逐词解析到整篇译文。所有的数据应该是可重用的。可重用意味着在技术层面应该存储计算机可辨识的格式的数据。
-- **智能重用** 程序应根据经文类型（经藏或律藏）或其他特征，提供提供不同的数据给用户。或将数据列表按信心指数排序。以减少不必要的人工劳动。
-- **公共版权** 有版权的信息与前两条原则违背。所以，一切在本平台公开的数据都应使用公共版权。
-- **平等的发言权** 每个平台的使用者都有权发表自己的观点。平台不应以官方的角度用人工的方式评价观点的正确性或给予排名靠前或靠后的操作。但是平台应该记录和向所有人提供统计数据，如：信息发布者的使用经验数值（使用平台时间，发表信息量，被点赞量等），阅读者的阅读数据（阅读量，收藏量）供阅读者自己判断信息的可用性。没有实质内容的信息（如：“很好”；“太差了”等）将对读者造成困扰，增加读者搜寻有用信息的时间。管理员应根据判定规则，将信息隐藏。在读者选择“查看隐藏的内容”时展示。
-
-## 开发文档包含
-
-* [API 接口](api/readme.md)
-* [前端文档](dashboard/readme.md)
-* [数据库设计](db/readme.md)
-* [运维](deploy/readme.md)
-
-git commit message格式 请参见https://gitmoji.dev/
-
-用户手册请参考https://github.com/iapt-platform/help.zh-hans

documents/zh/summary.md

@@ -1,4 +0,0 @@
-* [API 接口](api/readme.md)
-* [前端文档]](dashboard/readme.md)
-* [数据库设计]](db/readme.md)
-* [运维]](deploy/readme.md)