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 のルールを9カテゴリに分類し、各ルールのファイルに例と確認項目を用意しています。

主な機能

  1. 015種類のプロジェクトに対応
  2. 0225ルールを9カテゴリに分類
  3. 03インストールと Provider の設定案内
  4. 04ユーザー ID とドキュメントの設定案内
  5. 05例と確認チェックリスト

活用シーン

  1. 01新規プロジェクトへの Velt 導入
  2. 02VeltProvider と API キーの設定
  3. 03ユーザー ID と 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インストールCRITICALinstall-
2プロバイダーの接続CRITICALprovider-
3アイデンティティCRITICALidentity-
4ドキュメントのアイデンティティCRITICALdocument-
5設定HIGHconfig-
6プロジェクト構成MEDIUMstructure-
7ルーティング対象MEDIUMsurface-
8コンポーネントMEDIUMcomponent-
9デバッグとテストLOW-MEDIUMdebug-

使用方法

詳しい説明とコード例については、各ルールファイルを参照してください。

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 対応