chore(filetree): complete framework design for core

HydroRoll-Team · Mar 12, 2024 · 91ebc76 · 91ebc76
1 parent b29525e
commit 91ebc76
Show file tree

Hide file tree

Showing 17 changed files with 29 additions and 6 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,3 @@
 {
-    "restructuredtext.preview.name": "sphinx"
+    "restructuredtext.preview.name": "docutils"
 }
diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@
 
 
 HydroRoll-Core <=> 水系核心
-==========================
+===========================
 
 去中心化应用程序。
 
@@ -25,6 +25,32 @@ HydroRoll-Core <=> 水系核心
 - 📚 *PDF* 生成，结合自定义 *PDF* 模板，能够生成符合需求的 *PDF* 书籍。
 - 🌏 离线文档与在线协作站点，使用 *Sphinx* 框架与 *Vue* 技术栈生成本地文档与在线站点。
 
+架构设计
+--------
+
+核心模块 ``corelib``
+
+包含 *CLI* 界面，用于单独使用。
+包含 *REST API* 和 *WebSocket* 通信模块，以便其他语言能够接入和与之交互。
+集成请求处理模块，确保能够处理大量请求。
+
+规则包加载模块 ``Rule Pack Loading Module``
+
+负责读取约定式的规则包。
+利用并行处理技术，可通过Rust实现以提高性能。
+
+PDF生成模块 ``PDF Generation Module``
+
+将规则包作为输入，结合高度自定义的PDF模板，生成符合要求的PDF书籍。
+
+文档站点生成模块 ``Documentation Site Generation Module``
+
+使用Sphinx框架生成本地在线文档站点。
+
+其他功能模块 ``Other Feature Modules``
+
+包括尚未确定的其他功能，如文档生成、数据分析等。
+
 ----
 
 `AGPL3.0`_ © 2023-PRESENT `简律纯`_ & `HydroRoll-Team`_.

diff --git a/hydro_roll_core/__init__.py b/hydro_roll_core/__init__.py
@@ -1,4 +1 @@
-from . import corelib
-
-def sum_words(a: str, b: str) -> str:
-    return a + b
+from . import corelib
diff --git a/hydro_roll_core/cli.py b/hydro_roll_core/cli.py
diff --git a/hydro_roll_core/config.py b/hydro_roll_core/config.py
diff --git a/hydro_roll_core/const.py b/hydro_roll_core/const.py
diff --git a/hydro_roll_core/dependencies.py b/hydro_roll_core/dependencies.py
diff --git a/hydro_roll_core/dev/__init__.py b/hydro_roll_core/dev/__init__.py
diff --git a/hydro_roll_core/docs/__init__.py b/hydro_roll_core/docs/__init__.py
diff --git a/hydro_roll_core/exceptions.py b/hydro_roll_core/exceptions.py
diff --git a/hydro_roll_core/features/__init__.py b/hydro_roll_core/features/__init__.py
diff --git a/hydro_roll_core/log.py b/hydro_roll_core/log.py
diff --git a/hydro_roll_core/performance/__init__.py b/hydro_roll_core/performance/__init__.py
diff --git a/hydro_roll_core/py.typed b/hydro_roll_core/py.typed
diff --git a/hydro_roll_core/rule_package.py b/hydro_roll_core/rule_package.py
diff --git a/hydro_roll_core/typing.py b/hydro_roll_core/typing.py
diff --git a/hydro_roll_core/utils.py b/hydro_roll_core/utils.py