Skip to content

docs: add a coding agent section to the SDKs page - #2362

Merged
comfyui-wiki merged 2 commits into
mainfrom
docs/sdk-coding-agent-section
Nov 15, 2026
Merged

comfyui-wiki merged 2 commits into
mainfrom
docs/sdk-coding-agent-section

Conversation

@comfyui-wiki

@comfyui-wiki comfyui-wiki commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

Adds a Coding agents section to the SDKs page and its four locales, so a reader who hands this integration to an agent gets the skill pointer without reading a wall of text.

What changed

  • development/api-development/sdks.mdx: new ## Coding agents section after <SdkVersions />, before ## Quickstart.
  • zh/development/api-development/sdks.mdx: same section as ## 编程智能体.
  • ja/development/api-development/sdks.mdx: same section as ## コーディングエージェント.
  • ko/development/api-development/sdks.mdx: same section as ## 코딩 에이전트.
  • es/development/api-development/sdks.mdx: same section as ## Agentes de programación.

All four localized files also get a refreshed translationSourceHash and a new "Coding agents" entry in translationBlockHashes, produced by bun .github/scripts/i18n/sync-hash-i18n.ts (no translation API call).

Why

The section was one dense paragraph: 113 words, a six-item list crammed inline, and the two /plugin commands buried in prose. Splitting it into a lead, a bullet list, and a fenced command block makes it scannable and matches how /agent-tools/skills already presents install commands.

An alternative wording for the section in #2315; #2315 is left untouched.

Deliberate choices

  • Placement: the section stays directly after Install (<SdkVersions />) and before Quickstart. A coding agent is the substitute for hand-writing the client, so it belongs before the first code sample, not at the end of the page.
  • Command block: the two /plugin commands move out of inline text into a bare fenced block, matching agent-tools/skills.mdx. No language tag, so no syntax highlighter is invoked on slash commands that are not a language.
  • es anchor: this branch changes nothing about the [Límites de simultaneidad](/es/development/deploy/cloud-usage#límites-de-simultaneidad) link. It was checked while reviewing this page because the anchor gate only scans changed files, and on main it already resolves correctly (#límites-de-simultaneidad, matching the ## Límites de simultaneidad heading in es/development/deploy/cloud-usage.mdx). An earlier draft expected #tareas-simultáneas here; no such anchor exists anywhere in the repo, so there is nothing to fix.

Verification

$ python3 .github/scripts/check-anchors.py --file development/api-development/sdks.mdx
Checking 1 file(s) for anchor links...
✅ All anchor links OK!

$ python3 .github/scripts/check-anchors.py --file zh/development/api-development/sdks.mdx
Checking 1 file(s) for anchor links...
✅ All anchor links OK!

$ python3 .github/scripts/check-anchors.py --file ja/development/api-development/sdks.mdx
Checking 1 file(s) for anchor links...
✅ All anchor links OK!

$ python3 .github/scripts/check-anchors.py --file ko/development/api-development/sdks.mdx
Checking 1 file(s) for anchor links...
✅ All anchor links OK!

$ python3 .github/scripts/check-anchors.py --file es/development/api-development/sdks.mdx
Checking 1 file(s) for anchor links...
✅ All anchor links OK!

$ bun .github/scripts/i18n/check-structure-parity.ts --base origin/main
checked 8 localized file(s), skipped 0
Structure parity: OK
(exit 0)

$ python3 .github/scripts/validate-links.py
Found 9936 documentation files
Mode: fix formatting (.mdx extensions, slashes)
✅ All link validations passed!

Hash sync output:

$ bun .github/scripts/i18n/sync-hash-i18n.ts development/api-development/sdks.mdx
=== sync-hash (pages) ===
development/api-development/sdks.mdx:
  [ja] synced hash: ja/development/api-development/sdks.mdx
  [zh] synced hash: zh/development/api-development/sdks.mdx
  [ko] synced hash: ko/development/api-development/sdks.mdx
  [es] synced hash: es/development/api-development/sdks.mdx

=== sync-hash (snippets) ===
development/api-development/sdks.mdx (snippet):

Done: 4 updated, 0 already in sync, 0 missing target(s)

translationSourceHash moved from fd912955 to da14b84c in all four locales, and the "Coding agents" block-hash entry is present in each. The scoped invocation touched no files outside the five in this PR.

Diff:

 development/api-development/sdks.mdx    | 24 ++++++++++++++++++++++++
 es/development/api-development/sdks.mdx | 27 ++++++++++++++++++++++++++-
 ja/development/api-development/sdks.mdx | 27 ++++++++++++++++++++++++++-
 ko/development/api-development/sdks.mdx | 27 ++++++++++++++++++++++++++-
 zh/development/api-development/sdks.mdx | 27 ++++++++++++++++++++++++++-
 5 files changed, 128 insertions(+), 4 deletions(-)

No em dashes in the diff. pnpm translate was not run, so no translation API quota was spent; the localized prose is hand-written and the hashes reflect it.


Note

Low Risk
Documentation and i18n metadata only; no runtime or API behavior changes.

Overview
Refactors the SDKs page Coding agents block (formerly a single dense paragraph under “Using a coding agent”) into a short intro, a bullet list of what the comfy-sdk skill covers, explicit workflow-client guidance, and a fenced block for the two Claude Code /plugin install lines. Other agents are pointed at copying SKILL.md into AGENTS.md or Cursor rules.

The same structure and wording refresh is applied in es, ja, ko, and zh, with translationSourceHash and the "Coding agents" translationBlockHashes entry synced to the English source.

Reviewed by Cursor Bugbot for commit 6c8029e. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Nov 15, 2026, 6:58 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The SDK guides rename and reorganize the coding-agent section in five languages. They describe the comfy-sdk skill’s topics and scope, and retain installation guidance for Claude Code and other agents.

Changes: Coding agent guidance

Layer / File(s) Summary
Update the English coding-agent guidance
development/api-development/sdks.mdx
Renames the section to “Coding agents” and lists the skill’s topics. The guide retains its scope distinction, workflow-client guidance, and setup instructions.
Update translated coding-agent guidance
es/development/api-development/sdks.mdx, ja/development/api-development/sdks.mdx, ko/development/api-development/sdks.mdx, zh/development/api-development/sdks.mdx
Updates translation metadata and reorganizes the translated section. The guides retain their skill-scope descriptions and setup instructions.

Suggested reviewers: mattmillerai

Merge Risk: Minimal · up to 6c802

This change updates the coding-agent documentation in five languages. It has no runtime impact and no concrete merge-blocking issue was found.

Pre-merge checks: Passed 2

Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
Simplify code

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

CI annotation context is incomplete: annotation collection unavailable or limited

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 23e327e3-ce66-424d-b640-e7f346c36ac0
Commits

Reviewing files that changed from the base of the PR and between d04fa8e and 6c8029e.

Files selected for processing: 5

  • development/api-development/sdks.mdx
  • es/development/api-development/sdks.mdx
  • ja/development/api-development/sdks.mdx
  • ko/development/api-development/sdks.mdx
  • zh/development/api-development/sdks.mdx

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

@coderabbitai
coderabbitai Bot requested a review from mattmillerai November 15, 2026 06:58
@comfyui-wiki
comfyui-wiki merged commit d50ed07 into main Nov 15, 2026
15 checks passed
@comfyui-wiki
comfyui-wiki deleted the docs/sdk-coding-agent-section branch November 15, 2026 07:01

This branch was successfully deployed

1 active deployment
staging — 6c8029e1 Deployed Nov 15, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant