# eai-frontend

**Repository Path**: eai-code/eai-frontend

## Basic Information

- **Project Name**: eai-frontend
- **Description**: 前端交互层 | CLI · VSCode 插件 · MCP 服务
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-23
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# eai-frontend

> **eai-code 生态的"知识层":领域方法论的 RAG 库**
>
> 沉淀嵌入式可视化 / 调试上位机 / 测试脚本 / 信号处理等领域的设计模式、选型决策、代码 pattern、反例坑。被 AI 通过 RAG 检索参考,不直接运行代码。

[![status](https://img.shields.io/badge/status-v0.1%20架构定论-blue)](./decisions/0001-initial-structure.md) [![license](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE) [![ecosystem](https://img.shields.io/badge/eai--code-ecosystem-orange)](https://gitee.com/eai-code)

---

## 1. 定位

eai-frontend 不是"前端代码仓库",是**领域方法论的 RAG 库**:

- ❌ 不存具体项目实现(实现由 agent 在项目里生成,放项目 `tools/` 或 `visualization/`)
- ❌ 不部署运行(纯静态知识层,不打包 / 不发布 / 不运行)
- ✅ 存"怎么做"的方法论(pattern / 选型 / 契约 / 坑)
- ✅ 被 AI 通过 RAG 检索参考

**AI 时代,仓库价值不在代码本身,而在可被 AI 检索复用的方法论。**

## 2. 三仓库分工

| 仓库 | 层 | 内容 | 类比 |
|---|---|---|---|
| eai-coder | 编排层 | PM + META RAG + agent 调度 | 教务处 |
| **eai-frontend** | **知识层** | **领域方法论 RAG** | **教科书** |
| eai-agent | 角色层 | agent 人格 + 经验 | 老师 |

## 3. 架构:单数据源 + 多维 metadata 索引

**核心思想**:内容物理存储一份(`entries/`),靠 metadata 多维索引,实现"按形态查"和"按主题查"两个维度并存,不重复存储。

```
eai-frontend/
├── README.md                       本文件
├── decisions/                      架构决策记录(ADR)
│   └── 0001-initial-structure.md   初始化结构定论
├── entries/                        ⭐ 裸数据,只存一份(按 ID 命名)
│   ├── METH-001-imu-mahony-fusion.md
│   ├── PAT-002-matplotlib-realtime.py
│   └── ...
└── index.yml                       ⭐ 多维索引(指针)
    # by_form: methodology / pattern / decision / contract / anti-pattern
    # by_domain: imu / visualization / calibration / debugging / scripting
    # by_stack: python / c / embedded / web / ...
```

**每个 entry 的 frontmatter**(指针的本质):
```yaml
---
id: METH-001
form: methodology           # 形态维度
domain: [imu, calibration]  # 主题维度(可多主题)
stack: [c, embedded]        # 技术栈维度
applies_to: [imu-engineer, business-logic-engineer]
keywords: [mahony, 姿态融合, ...]
source: derived-from-eai-wand-P2
status: draft | reviewed | canonical
version: 1.0
---
```

## 4. RAG 接入路径

eai-coder MCP server 提供 `rag_query_frontend` tool(注册到 rag-engine 数据源注册机制),agent 做可视化/算法任务时:

1. **前置步骤**:RAG 检索 eai-frontend 方法论
2. **执行**:按检索���的 pattern + 决策树生成代码
3. **回流**:任务完成后,PM 提炼新方法论写进 entries/

详见 [decisions/0001-initial-structure.md](./decisions/0001-initial-structure.md) 决策 2。

## 5. 演进计划

| 阶段 | 内容 | 状态 |
|---|---|---|
| v0.1 | 架构定论 + decisions/0001 + README | ✅ 完成 |
| v0.2 | 首填充:IMU 滤波算法对比研究(7 entries:METH-001~004 + DEC-001 + ANTI-001 + PAT-001) | ✅ 完成(2026-07-24) |
| v0.3 | 接入 eai-coder RAG(rag_query_frontend tool) | ⏳ 待办 |
| **v0.4(当前)** | **第二次填充:可视化上位机 pattern(4 entries:PAT-002 / DEC-002 / ANTI-002 / PAT-003,来自 eai-wand P3)** | **✅ 完成(2026-07-25)** |
| v0.5 | 跨项目共享验证(新项目 agent 检索复用本批次方法论) | ⏳ 待办 |

## 6. 维护纪律

- **不写实现代码进 eai-frontend**:agent 在项目里生成的代码放项目 `tools/` 或 `visualization/`,只在 eai-frontend 沉淀方法论
- **每次 agent 完成可视化/算法任务后**:PM 提炼方法论(选型 / pattern / 坑)写进 entries/,更新 index.yml
- **entry status 流转**:draft(初稿) → reviewed(PM 复核) → canonical(多项目验证后固化)
- **关联 eai-agent**:每个 domain 的方法论,对应 eai-agent 中该领域 agent 的知识来源

---

## 7. 文档索引

- [decisions/0001-initial-structure.md](./decisions/0001-initial-structure.md) —— 初始化结构定论(4 个核心决策)
- eai-coder 主仓 `docs/14` —— 嵌入式开发标准流程与多 Agent 分工
- eai-coder 主仓 `docs/13` —— MCP server 形态
- eai-coder PM memory `project_eai_frontend_rag_library.md` —— 定位推演过程

## 8. License

Apache-2.0(与 eai-code 生态其他仓库一致)