feat: 第三优先级完善 — CI/CD、PyPI、pre-commit、CHANGELOG、贡献指南、基准测试、ADR

2026-07-11 20:13:36 +08:00
parent 7e0b9553c8
commit 2ddb6de92f
13 changed files with 483 additions and 12 deletions
@@ -1,5 +1,8 @@
 # md-vector-db

+[![CI](https://lhy-git.liuhangyv.top/Serendipity/md-vector-db/actions/workflows/ci.yml/badge.svg)](https://github.com/LHY0125/md-vector-db/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Markdown 文档向量数据库 — 将 Markdown 文件自动分块、嵌入、存入 ChromaDB，通过语义检索快速查找相关内容。提供 **CLI 命令行工具**和 **HTTP API** 两种使用方式供其他项目集成。

 ## 功能特性
@@ -180,14 +183,14 @@ docker exec -it md-vector-db uv run md-vector-db ingest /app/md_docs/doc.md

 所有命令均支持 `--config/-c`（配置文件）、`--collection/-C`（集合名，默认 `default`）。

-| 命令                              | 说明                                                     |
-| --------------------------------- | -------------------------------------------------------- |
+| 命令                                | 说明                                                     |
+| ----------------------------------- | -------------------------------------------------------- |
 | `ingest <文件路径> --incremental` | 增量入库单文件，自动跳过未变更文件                       |
 | `ingest <文件路径> --force`       | 强制重新入库（忽略增量检查）                             |
 | `ingest-dir <目录路径>`           | 递归入库目录下所有支持的文档格式                         |
-| `search <查询> -k <数量> --mode`  | 语义检索，`--mode hybrid\|vector`，`--json` JSON 输出  |
+| `search <查询> -k <数量> --mode`  | 语义检索，`--mode hybrid\|vector`，`--json` JSON 输出 |
 | `stats`                           | 显示 chunks 总数、源文件列表                             |
-| `export -o <文件> -f <json\|csv>` | 导出 collection 数据                                    |
+| `export -o <文件> -f <json\|csv>`  | 导出 collection 数据                                     |
 | `serve -p <端口>`                 | 启动 HTTP 服务（默认 8000）                              |

 ---
@@ -327,6 +330,16 @@ index-strategy = "unsafe-best-match"              # 允许跨源查找

 ---

+---
+
+## 文档
+
+- [API 参考](docs/api_reference.md)
+- [架构决策记录](docs/architecture.md)
+- 
+- [贡献指南](CONTRIBUTING.md)
+- [变更日志](CHANGELOG.md)
+
 ## License

 MIT