cloud-rag-doc

这是 cloud-rag-doc 的测试文档仓库，用来演示"微服务总结文档，定时同步到 RAG"的工作流。

目录约定

cloud-rag-doc/
├── README.md
├── ABOUT.md
├── _manifest.yml
├── 01-architecture/
├── 02-ingestion/
├── 03-examples/
└── assets/

规则：

• 正式文章必须放在一级分类目录中，目录名使用 NN-name；
• 正式文章文件名必须使用 kebab-case.md；
• 文件名必须和 frontmatter.id 一致；
• README.md、ABOUT.md、_manifest.yml 只做说明，不会同步到 RAG；
• status: published 会入库，status: draft 会被跳过。

如何创建一篇合规文章

1. 选择一个一级分类目录，例如 01-architecture/。
2. 复制 02-ingestion/microservice-template.md 作为新文章。
3. 把文件名改成你的文章 ID，例如 user-service-summary.md。
4. 修改 frontmatter：
   • id 必须和文件名一致，不带 .md
   • category 必须和目录一致，例如 microservice
   • tags 必须是数组
   • status 只能是 published 或 draft
   • createdAt 和 updatedAt 必须是合法日期
5. 正文第一行 # 标题 必须和 frontmatter.title 完全一致。
6. 写完后提交到 Git：

git add .
git commit -m "docs: add user-service-summary"

最小 Frontmatter 模板

---
id: user-service-summary
title: 用户服务总结
description: 用户管理服务的 API 和部署信息
category: microservice
tags:
  - user
  - api
status: published
createdAt: 2026-03-25
updatedAt: 2026-03-25
---

同步验证

在 RedisRAG 项目中配置：

export DOC_SYNC_REPO_URL=/Users/ga666666/Desktop/cloud-rag-doc
export DOC_SYNC_BRANCH=main
npm run sync:docs

或直接启动 Docker Compose，默认会把这个桌面目录挂载进容器并自动同步。