# merchant-frontend-ai-knowledge

**Repository Path**: webqiang99/merchant-frontend-ai-knowledge

## Basic Information

- **Project Name**: merchant-frontend-ai-knowledge
- **Description**: 前端 AI 知识库：AGENTS 门禁 + docs/spec 模块索引、业务 reference、链路说明与生成 Prompt，供 Cursor/Codex 按需加载，与业务代码仓分离维护。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-19
- **Last Updated**: 2026-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# merchant-frontend-ai-knowledge

商户端运营管理前端的 **AI 可导航项目知识库**（与业务代码仓库分离）。供 Cursor、Codex 等在改需求、写代码、做评审时 **按关键词按需加载** 上下文，避免全仓扫描。

## 仓库结构

```text
merchant-frontend-ai-knowledge/
├── README.md                 # 本文件
├── AGENTS.md                 # 维护本知识库仓的约定（非业务仓 AGENTS）
├── prompts/                  # 生成 / 更新 spec 的 Prompt 模板
├── templates/                # 新业务项目可复制骨架
│   ├── AGENTS.md.template
│   └── docs/spec/            # 空壳 + 模块 reference 模板
└── examples/
    └── private-business-web-html/   # 完整示例（来自业务仓快照）
        ├── AGENTS.md
        └── docs/
```

## 快速开始

### 1. 新建业务前端的知识库

1. 复制 `templates/` 到业务仓根目录（或作为 submodule 挂载到 `docs/`）。
2. 将 `templates/AGENTS.md.template` 重命名为 `AGENTS.md`，把 `{KNOWLEDGE_ROOT}` 换成实际路径。
3. 使用 `prompts/bootstrap-project.md`，填入项目名、技术栈、业务域列表，让 AI 生成 `docs/spec/*`。

### 2. 在业务仓中引用本仓（submodule 示例）

```bash
# 在 private-business-web-html 根目录
git submodule add <本仓 URL> knowledge
```

业务仓 `AGENTS.md` 中指向：

```markdown
- 知识库路径：`knowledge/examples/private-business-web-html/docs/spec`（或你们同步后的路径）
- 先读 `docs/spec/index.md` …
```

### 3. 参考完整示例

见 [`examples/private-business-web-html/`](examples/private-business-web-html/README.md)：包含从 `private-business-web-html` 迁出的 `AGENTS.md` 与完整 `docs/`（含 `docs/spec`、接口映射等）。

## 维护原则

- **本仓**：稳定、可检索的业务地图 + AI 规则 + Prompt。
- **业务仓**：Vue 源码；需求原文可留在 Confluence 或 `docs/requirements-confluence`。
- 改接口 / 路由 / 权限时，**同一迭代** 内同步更新对应 `docs/spec/reference/*.md`。
- 单条 reference 保持短小；不确定写「待确认」，不编造 API 路径。

## 相关业务代码仓

| 业务仓 | 说明 |
|--------|------|
| `private-business-web-html` | 商户端运营前台（本仓库 example 来源） |

## 许可证

内部项目，由前端团队维护。