Skip to content

docs: add the Video Edit widget page for the video trim and crop nodes - #1868

Open
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/video-edit-widget
Open

lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/video-edit-widget

Conversation

@lin-bot23

@lin-bot23 lin-bot23 commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds interface/features/video-edit.mdx (EN + zh/ja/ko) for the interactive Video Edit widget that ComfyUI renders inside the Trim Video (Advanced) (VideoTrim) and Crop Video (VideoCrop) nodes, and registers it in the Interface Guide navigation for all four languages.

The built-in node reference pages describe the node parameters only (start_time / duration for trim, x / y / width / height for crop). The widget itself (filmstrip with start/end frame handles, crop box over the preview, playback row, metadata rows) had no documentation anywhere.

Fact sources

  • ComfyUI_frontend src/components/videoEdit/ (WidgetVideoEdit.vue, VideoEditPanel.vue, VideoFilmstripTrim.vue, VideoCropOverlay.vue) for the controls, the empty state, and the metadata rows.
  • ComfyUI_frontend src/composables/video/useVideoEditModel.ts for how the start/end frame handles map to start_time plus duration, and the duration 0 behavior when the end handle sits on the last frame.
  • ComfyUI_frontend src/locales/{en,zh,ja,ko}/{main.json,nodeDefs.json} for the localized node display names, the category label, and the field labels used on the page.
  • ComfyUI_frontend src/renderer/extensions/vueNodes/widgets/registry/widgetRegistry.ts for the widget registration (the editor is a modern node design / Nodes 2.0 widget, so the page links the Nodes 2.0 setting).
  • ComfyUI comfy_extras/nodes_video.py (VideoTrim, VideoCrop) and comfy_api/latest/_io.py (VIDEO_EDIT io type) for the node side of the widget.

Scope and checks

  • 4 languages in one PR: EN page, zh/ja/ko translations, docs.json nav entry once per language (inserted through the canonical location and re-generated with bun .github/scripts/snippets/gen-code-pages.ts so the code-pages freshness check stays green).
  • Translated with pnpm translate -- interface/features/video-edit.mdx --no-openapi, then the zh/ja/ko node names, field labels, and category terms were corrected by hand against the frontend locale files, and pnpm translate:sync-hash refreshed the hashes.
  • An independent verification pass against the frontend and ComfyUI source corrected three claims before the final push: the library category is Video (not "Video Tools", which is only an essentials_category backend field), the preview starts unmuted (the mute button silences it), and the ratio list sits below the preview.
  • No images: there is no screenshot of this widget under images/ yet. Both nodes render it inline in the node body, so a screenshot would need a running graph.
  • Local checks: check-anchors.py passes on all four files, structure-parity reports no failures, no em dashes, 5 H2 sections in each language, no leading pipes.

cc @lin-bot23

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (2)
.cursor/rules/docs-frontmatter.mdc — auto-discovered
.github/scripts/i18n/README.md — configured

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 6b753333-25b6-41b8-a8e0-d8fbca2f28be
📥 Commits

Reviewing files that changed from the base of the PR and between e42b884 and 1be4ad4.

📒 Files selected for processing (5)
  • docs.json
  • interface/features/video-edit.mdx
  • ja/interface/features/video-edit.mdx
  • ko/interface/features/video-edit.mdx
  • zh/interface/features/video-edit.mdx

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


📝 Walkthrough

Walkthrough

The pull request adds Video Edit widget guides in English, Japanese, Korean, and Chinese. The guides document trim and crop controls, preview and loading behavior, workflow values, troubleshooting, and related node references. The guides are added to the matching Interface Guide navigation lists.

Changes

Video Edit documentation

Layer / File(s) Summary
Video Edit guides
interface/features/video-edit.mdx, ja/interface/features/video-edit.mdx, ko/interface/features/video-edit.mdx, zh/interface/features/video-edit.mdx
Adds guides that describe trim and crop controls, preview behavior, workflow values, troubleshooting, and related node references.
Interface Guide navigation
docs.json
Adds the Video Edit guide to the English, Chinese, Japanese, and Korean Interface Guide page lists.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to 1be4a

This PR adds localized documentation and navigation without changing video-processing behavior. No concrete defect is established; the final-frame wording remains unverified against the frontend implementation.

Architecture Summary

Architecture risk: 🔵 Low · up to 1be4a

The change affects 5 systems.

Changed systems: docs.json, interface, ja, ko, zh

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs.json (service) was modified; 1 changed file maps to changed impact.
  • observed — interface (service) was modified; 1 changed file maps to changed impact.
  • observed — ja (service) was modified; 1 changed file maps to changed impact.
  • observed — ko (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs.json: Added interface/features/video-edit to the English Interface Guide page list.
  • observed — Modified behavior in docs.json: Added zh/interface/features/video-edit to the Chinese Interface Guide page list.
  • observed — Modified behavior in docs.json: Added ja/interface/features/video-edit to the Japanese Interface Guide page list.
  • observed — Modified behavior in docs.json: Added ko/interface/features/video-edit to the Korean Interface Guide page list.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
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)
  • Create a new PR
✨ Simplify code
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@lin-bot23
lin-bot23 force-pushed the docs/video-edit-widget branch from 98fbee6 to 1b8c75c Compare October 3, 2026 09:09
@lin-bot23
lin-bot23 force-pushed the docs/video-edit-widget branch from 1b8c75c to 1be4ad4 Compare October 3, 2026 09:11

This branch has not been deployed

No deployments
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