Files
RAG/docs/README.md
YoVinchen ec1acb36b5
Some checks failed
secret-scan / scan (push) Has been cancelled
Establish a safe foundation before implementing the geology RAG system
The project begins with architecture, data governance, reproducible evaluation, deployment boundaries, and secret-handling contracts so later code has measurable acceptance criteria.

Constraint: Real provider credentials, workspace identities, and restricted geological data must never enter Git

Rejected: Add placeholder runnable services in the design commit | would imply unverified implementation readiness

Confidence: high

Scope-risk: narrow

Reversibility: clean

Directive: Run make verify before every commit and update ADRs when architecture boundaries change

Tested: Secret scan, Markdown links, YAML parse, shell syntax, and staged diff validation

Not-tested: Application runtime is intentionally deferred to the implementation stage
2026-07-12 14:42:11 +08:00

868 B

设计文档索引

文档 内容 状态
00-overall-design.md 项目范围、总体架构、技术选型、接口、数据模型与 RAG 主流程 设计基线完成
01-data-and-evaluation.md 语料治理、解析、验证集生成、向量入库测试和论文评测 设计基线完成
02-deployment-and-security.md Docker Compose、配置、密钥、监控、备份和安全 设计基线完成
03-implementation-plan.md 阶段计划、完成定义、测试与验收清单 设计基线完成
adr/ 不易逆转的架构决策记录 持续维护

文档中的工作空间地址统一使用 <workspace-id> 占位符;真实地址和凭证均属于部署配置,不写入仓库。