用途
Velt Suggestions Best Practices 是一份针对 Velt Suggestions API 的实现指南,主题是「先提议、后审阅」(propose-then-review)的编辑工作流:来自人类或 AI 智能体的编辑会被捕获为建议(proposal),再由审阅者接受或拒绝。该指南按用途适用于在 React、Next.js 及 Web 应用中添加建议模式(suggestion mode)。
何时适用
资料列出以下适用场景:
- 为表单输入、表格或自定义组件添加建议模式;
- 实现「AI 提议 / 人工审阅」的工作流;
- 将 data-velt-suggestion-target 属性绑定到 DOM 元素;
- 处理接受 / 拒绝事件并应用被接受的变更;
- 按目标或状态查询建议,以构建自定义 UI;
- 理解建议的生命周期状态(pending → accepted/rejected/stale)。
规则分类与优先级
指南包含 6 个类别、共 14 条规则,按优先级排列如下:
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | Core | CRITICAL | core- |
| 2 | Targets | CRITICAL | targets- |
| 3 | Mode | HIGH | mode- |
| 4 | Capture | HIGH | capture- |
| 5 | Lifecycle | HIGH | lifecycle- |
| 6 | Data | MEDIUM | data- |
前置条件
Suggestions 需要先完成 Velt Comments 的配置——接受 / 拒绝 UI 会渲染在 Velt 评论对话框上。在添加 Suggestions 之前,需确保 VeltProvider 已配置 authProvider,且 Comments 正常工作。
已编译文档
- AGENTS.md:所有规则的压缩索引,含文件路径(建议从这里开始);
- AGENTS.full.md:完整详细指南,所有规则内联展开。
使用方式
资料未提供具体的安装命令或代码示例;文中出现的属性名 data-velt-suggestion-target 与配置项 VeltProvider、authProvider 均为资料原文内容。
限制
资料未说明收费、价格、平台支持范围或实际效果;具体规则内容仅在 AGENTS.md 与 AGENTS.full.md 中展开,本条目未提供这些文件内容。