mcpField
V
velt-setup-best-practices

velt-setup-best-practices

github.com/velt-js开发149 次安装4 周前更新
代码仓库

关于 velt-setup-best-practices

为在 React、Next.js、Angular、Vue 和 HTML 项目中配置 Velt 协作 SDK 提供参考。内容将 25 条规则分为九类，具体规则文件含示例和验证清单。

主要功能

  1. 01覆盖五种项目类型
  2. 0225 条规则分为九类
  3. 03安装与 Provider 配置指引
  4. 04用户身份与文档设置指引
  5. 05示例和验证清单

适用场景

  1. 01在新项目中集成 Velt
  2. 02配置 VeltProvider 和 API 密钥
  3. 03设置用户身份及 JWT 生成
  4. 04查找项目组织相关规则

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/velt-js/agent-skills --skill velt-setup-best-practices

安装后在 Claude Code 中输入/velt-setup-best-practices确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.full.md
AGENTS.md
metadata.json
README.md
evals/
evals.json
rules/non-react/installation/
install-vanilla-packages.md
rules/non-react/provider-wiring/
provider-framework-init.md
rules/react/identity/
identity-auth-provider.md
rules/react/installation/
install-react-packages.md
rules/react/project-structure/
structure-folder-organization.md
structure-separation-of-concerns.md
rules/react/provider-wiring/
provider-client-directive.md
provider-velt-provider-setup.md
rules/react/routing-surfaces/
surface-collaboration-wrapper.md
surface-component-placement.md
rules/shared/
_sections.md
_template.md
rules/shared/components/
component-user-invite.md
rules/shared/config/
config-api-key.md
config-auth-token-security.md
config-domain-safelist.md
config-firestore-persistent-cache.md
config-proxy-config.md
rules/shared/debugging-testing/
debug-common-issues.md
debug-multi-user-testing.md
debug-setup-verification.md
rules/shared/document-identity/
document-id-generation.md
document-metadata.md
document-page-info.md
document-set-document.md

详细介绍

Velt 设置最佳实践

Velt 协作 SDK 的综合设置指南。包含 9 个类别中的 25 条规则，涵盖安装、身份验证、文档设置和项目组织。

适用时机

在以下情况下，请参考这些指南：

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

按优先级划分的规则类别

优先级类别影响前缀
1安装严重install-
2Provider 接线严重provider-
3身份严重identity-
4文档身份严重document-
5配置高config-
6项目结构中structure-
7路由界面中surface-
8组件中component-
9调试与测试低至中debug-

使用方法

阅读各规则文件，了解详细说明和代码示例：

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 — 展开内含所有规则的完整详细指南

评论

支持 Markdown