velt-setup-best-practices

用途

Velt Setup Best Practices 是面向 Velt 协作 SDK 的搭建实践技能，用于在 React、Next.js、Angular、Vue 和 HTML 项目中完成首次集成与配置。该技能以规则集形式提供指引，帮助开发者在搭建阶段遵循一致的安装、认证、文档初始化与项目组织方式。

主要能力

该技能包含 25 条规则，分布在 9 个类别中，涵盖安装、认证、文档设置和项目组织。规则按优先级划分为多个层级：

• CRITICAL（关键）：安装（install-）、Provider 接线（provider-）、身份（identity-）、文档标识（document-）
• HIGH（高）：配置（config-）
• MEDIUM（中）：项目结构（structure-）、路由呈现面（surface-）、组件（component-）
• LOW-MEDIUM（低到中）：调试与测试（debug-）

每条规则文件包含：为何重要的简要说明、带解释的错误代码示例、带解释的正确代码示例、验证清单，以及指向官方文档的出处。

使用方式

在以下场景中可参考这些指南：

• 在全新的 React、Next.js、Angular、Vue 或 HTML 项目中搭建 Velt
• 配置 VeltProvider 与 API 密钥
• 使用 Velt 实现用户认证（userId、organizationId）
• 为生产环境设置 JWT 令牌生成
• 使用 documentId 初始化文档
• 组织项目中的 Velt 相关文件

可阅读单条规则文件获取详细说明与代码示例，例如：

• rules/react/installation/install-react-packages.md
• rules/react/provider-wiring/provider-velt-provider-setup.md
• rules/shared/_sections.md

同时提供编译好的文档：

• AGENTS.md — 所有规则的压缩索引及文件路径（建议从这里开始）
• AGENTS.full.md — 完整详尽的指南，所有规则内联展开

适用场景

适用于需要在上述前端技术栈中集成 Velt 协作能力的项目初始化阶段，尤其是涉及用户身份、文档标识、Provider 配置与生产 JWT 设置等关键环节时。

限制

该技能的官方文本、具体规则内容、代码示例细节、支持的 SDK 版本、依赖包名称及版本、平台或收费信息在给定资料中暂未提供，需查阅对应规则文件与官方文档确认。