Skip to content

Commit 59dda0e

Browse files
snomiaoclaude
snomiao
and
claude
authored
feat(docs): add Claim My Node documentation for ComfyUI Registry (#311)
* feat(docs): add "Claim My Node" documentation to guide developers in claiming ownership of custom nodes in the ComfyUI Registry * feat(docs): add new page for "claim-my-node" to the registry documentation to enhance user guidance * feat(docs): add Chinese translation for claim-my-node documentation Add zh-CN translation for registry/claim-my-node.mdx to provide Chinese-language documentation for the node claiming feature. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * feat(docs): add images to claim-my-node documentation Add visual guidance images for the node claiming process: - Publisher selection interface - Claim process stage 1 interface - Images added to both English and Chinese versions - Dark/light mode support for better accessibility 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent a1d60cd commit 59dda0e

File tree

6 files changed

+186
-1
lines changed

6 files changed

+186
-1
lines changed

‎docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,7 @@
532532
"pages": [
533533
"registry/overview",
534534
"registry/publishing",
535+
"registry/claim-my-node",
535536
"registry/standards",
536537
"registry/cicd",
537538
"registry/specifications"

‎images/registry/claim-my-node/choose-a-publisher.png‎

9.71 KB
Loading

‎images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png‎

16.1 KB
Loading

‎package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎registry/claim-my-node.mdx‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: "Claim My Node"
3+
---
4+
5+
## Overview
6+
7+
The **Claim My Node** feature allows developers to claim ownership of custom nodes in the ComfyUI Registry. This system ensures that only the rightful authors can manage and update their published nodes, providing security and accountability within the community.
8+
9+
## What are Unclaimed Nodes?
10+
11+
As we migrate from ComfyUI Manager to the Comfy Registry with new standards, many custom nodes that were previously listed in the ComfyUI Manager legacy system now appear as "unclaimed" in the registry. These are nodes that:
12+
13+
- Were originally published in the ComfyUI Manager legacy system
14+
- Have been migrated to the Comfy Registry to meet the latest standards
15+
- Are waiting for their original authors to claim ownership
16+
17+
We provide an easy way for developers to claim these migrated nodes, ensuring a smooth transition from the legacy system to the new registry standard while maintaining proper ownership and control.
18+
19+
## Getting Started
20+
21+
To claim your nodes:
22+
23+
1. **Navigate to Your Unclaimed Node Page**: Visit your unclaimed node page, Click "Claim my node!" button.
24+
25+
2. **Create a Publisher (if you don't have one yet)**:
26+
- If you haven't created a publisher yet, you'll be prompted to create one. A publisher is required to claim nodes and manage them effectively.
27+
28+
3. **Select a Publisher**: Choose the publisher under which you want to claim the node. this step will redirect you to the claim page.
29+
30+
<img
31+
className="block dark:hidden"
32+
src="/images/registry/claim-my-node/choose-a-publisher.png"
33+
alt="Choose a Publisher - Light Mode"
34+
/>
35+
<img
36+
className="hidden dark:block"
37+
src="/images/registry/claim-my-node/choose-a-publisher.png"
38+
alt="Choose a Publisher - Dark Mode"
39+
/>
40+
41+
To claim the node under the choosed publisher, follow these steps:
42+
43+
1. **Review Node Information:**
44+
- Check the node details, including the name, repository link, and publisher status as shown on the screen.
45+
46+
<img
47+
className="block dark:hidden"
48+
src="/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png"
49+
alt="Claim Node Process Stage 1 - Light Mode"
50+
/>
51+
<img
52+
className="hidden dark:block"
53+
src="/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png"
54+
alt="Claim Node Process Stage 1 - Dark Mode"
55+
/>
56+
57+
2. **GitHub Authentication:**
58+
- Click the "Continue with GitHub" button to start the authentication process. Ensure you're logged in to the correct GitHub account with admin rights to the repository.
59+
60+
3. **Verify Admin Access:**
61+
- Once logged in, the system will verify if you have admin privileges for the specified GitHub repository. This step is crucial to ensure you have the necessary permissions.
62+
63+
4. **Claim the Node:**
64+
- If the verification is successful, Click "Claim" to claim the node. The publisher status will change, indicating ownership.
65+
66+
5. **Complete!:**
67+
- After successfully claiming the node, you can continue on [publishing](./publishing) and managing your node as the rightful owner.
68+
69+
## Frequently Asked Questions
70+
71+
<AccordionGroup>
72+
73+
<Accordion title="Who can claim nodes?">
74+
Any GitHub user can submit a claim request, but claims are verified against the original node repository and author information.
75+
</Accordion>
76+
77+
<Accordion title="How long does the claim process take?">
78+
Claims are automatically approved once GitHub admin permissions to the repository are verified. This happens instantly upon submitting your claim.
79+
</Accordion>
80+
81+
<Accordion title="What happens after my claim is approved?">
82+
Once approved, you'll have full control over your node's management, including publish versions, updates meta, deprecation, and policy settings.
83+
</Accordion>
84+
85+
<Accordion title="Can I claim nodes I didn't create?">
86+
No, claims are automatically validated against GitHub repository admin permissions. Only users with admin access to the original repository can successfully claim nodes.
87+
</Accordion>
88+
89+
<Accordion title="What if my claim is denied?">
90+
Claims are automatically processed based on GitHub admin permissions. If you don't have admin access to the repository, the claim will be automatically denied. Contact the repository owner to request admin access if you believe you should have ownership rights.
91+
</Accordion>
92+
</AccordionGroup>

‎zh-CN/registry/claim-my-node.mdx‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: "认领我的节点"
3+
---
4+
5+
## 概览
6+
7+
**认领我的节点**功能允许开发者在 Comfy Registry 中认领自定义节点的所有权。该系统确保只有合法的作者才能管理和更新其发布的节点，为社区提供安全性和问责制。
8+
9+
## 什么是未认领的节点？
10+
11+
随着我们从 ComfyUI Manager 迁移到具有新标准的 Comfy Registry，许多之前在 ComfyUI Manager 传统系统中列出的自定义节点现在在 Registry 中显示为"未认领"。这些节点包括：
12+
13+
- 最初在 ComfyUI Manager 传统系统中发布的节点
14+
- 已迁移到 Comfy Registry 以符合最新标准的节点
15+
- 等待其原始作者认领所有权的节点
16+
17+
我们为开发者提供了一种简单的方式来认领这些迁移的节点，确保从传统系统平滑过渡到新的 Registry 标准，同时保持适当的所有权和控制。
18+
19+
## 入门指南
20+
21+
要认领您的节点：
22+
23+
1. **导航到您的未认领节点页面**：访问您的未认领节点页面，点击"认领我的节点！"按钮。
24+
25+
2. **创建发布者（如果您还没有的话）**：
26+
- 如果您还没有创建发布者，系统会提示您创建一个。认领节点和有效管理节点需要发布者身份。
27+
28+
3. **选择发布者**：选择您想要用来认领节点的发布者。此步骤将重定向您到在选定发布者下的认领页面。
29+
30+
<img
31+
className="block dark:hidden"
32+
src="/images/registry/claim-my-node/choose-a-publisher.png"
33+
alt="选择发布者 - 浅色模式"
34+
/>
35+
<img
36+
className="hidden dark:block"
37+
src="/images/registry/claim-my-node/choose-a-publisher.png"
38+
alt="选择发布者 - 深色模式"
39+
/>
40+
41+
要在选定的发布者下认领节点，请按照以下步骤操作：
42+
43+
1. **查看节点信息：**
44+
- 检查节点详细信息，包括屏幕上显示的名称、仓库链接和发布者状态。
45+
46+
<img
47+
className="block dark:hidden"
48+
src="/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png"
49+
alt="认领节点流程第一步 - 浅色模式"
50+
/>
51+
<img
52+
className="hidden dark:block"
53+
src="/images/registry/claim-my-node/claim-a-sample-custom-node-under-my-publisher-stage-1.png"
54+
alt="认领节点流程第一步 - 深色模式"
55+
/>
56+
57+
2. **GitHub 身份验证：**
58+
- 点击"使用 GitHub 继续"按钮开始身份验证过程。确保您已登录到对该仓库具有管理员权限的正确 GitHub 账户。
59+
60+
3. **验证管理员访问权限：**
61+
- 登录后，系统将验证您是否对指定的 GitHub 仓库具有管理员权限。此步骤对于确保您具有必要的权限至关重要。
62+
63+
4. **认领节点：**
64+
- 如果验证成功，点击"认领"来认领节点。发布者状态将发生变化，表示所有权。
65+
66+
5. **完成！：**
67+
- 成功认领节点后，您可以作为合法所有者继续进行[发布](./publishing)和管理您的节点。
68+
69+
## 常见问题
70+
71+
<AccordionGroup>
72+
73+
<Accordion title="谁可以认领节点？">
74+
任何 GitHub 用户都可以提交认领请求，但认领会根据原始节点仓库和作者信息进行验证。
75+
</Accordion>
76+
77+
<Accordion title="认领过程需要多长时间？">
78+
一旦验证了对仓库的 GitHub 管理员权限，认领就会自动批准。这在提交认领时立即发生。
79+
</Accordion>
80+
81+
<Accordion title="我的认领被批准后会发生什么？">
82+
一旦获得批准，您将完全控制节点的管理，包括发布版本、更新元数据、弃用和策略设置。
83+
</Accordion>
84+
85+
<Accordion title="我可以认领不是我创建的节点吗？">
86+
不可以，认领会根据 GitHub 仓库管理员权限自动验证。只有对原始仓库具有管理员访问权限的用户才能成功认领节点。
87+
</Accordion>
88+
89+
<Accordion title="如果我的认领被拒绝怎么办？">
90+
认领基于 GitHub 管理员权限自动处理。如果您对仓库没有管理员访问权限，认领将自动被拒绝。如果您认为自己应该拥有所有权权利，请联系仓库所有者请求管理员访问权限。
91+
</Accordion>
92+
</AccordionGroup>

0 commit comments

Comments
 (0)