docs: standardize tutorial pages with Card components, blob URLs, and i18n fixes - #1287
Open
lin-bot23 wants to merge 31 commits into
Open
docs: standardize tutorial pages with Card components, blob URLs, and i18n fixes#1287lin-bot23 wants to merge 31 commits into
lin-bot23 wants to merge 31 commits into
Conversation
…ixes - Replaced <a> tags with Mintlify CardGroup+Card components - Added Cloud+Download workflow cards with UTM params - Fixed resolve/main to blob/main URLs - Removed em dashes across tutorials - Synced zh/ja/ko translations to match EN structure
|
Important Review skippedToo many files! This PR contains 527 files, which is 427 over the limit of 100. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. Usage-priced reviews support at most 300 files. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (527)
You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- Revert all ja, zh, ko translation file changes (246 files) Translation file changes must go through the pipeline - Replace 16 em dashes with colons in 5 English tutorial files per project prose style guide
Contributor
Author
Cleanup SummaryThis update cleans up PR #1287 to comply with repo conventions:
|
Wrap remaining workflow cards in CardGroup cols={2}, normalize HF/GitHub
links to blob format, add Cloud UTM params, and sync i18n fixes for
triposplat, wan-alpha, and hunyuan-video-1-5.
Resolve i18n pricing.mdx conflicts by taking main (HeyGen pricing sync).
…grouping Standardize workflow pages across tutorials (CardGroup, blob URLs, UTM, preview/output assets) in EN/zh/ja/ko, group Partner Nodes sidebar by modality, reorder Image/LTX sections, and add tutorial-workflow-standard skill scripts.
…rse error Add short zh/ko Card descriptions, consolidate tutorial-workflow-standard scripts into audit_workflows.py, fix unclosed details in ko kling-motion-control, and localize /interface/features/subgraph links for validate-links CI.
Fix MDX parse errors reported by mint broken-links CI.
Revert 17 tutorial locales to main Japanese/Chinese/Korean prose where sync_i18n_workflows had pasted English workflow sections, then re-apply short localized Card body text for remaining EN snippets.
Sync ja/zh/ko tutorials with updated English workflow standardization using the incremental translate pipeline, fix snippet translations, and repair unclosed code fences from chunked output.
Insert missing newlines between closing JSX tags, code fences, and headings when translation concatenated blocks without paragraph breaks.
Restore ja/zh/ko built-in-nodes to match main; these files were accidentally touched by the MDX newline repair script.
Restore ja/zh/ko pages and non-tutorial snippets to main. They were included when translation commits used broad git add and repair-truncated touched pending files outside tutorials/.
Resolve docs.json conflict: keep Partner Nodes modality grouping from PR, add tripo-p1 nav entries from main.
# Conflicts: # docs.json # ja/tutorials/partner-nodes/kling/kling-3-0.mdx # ja/tutorials/partner-nodes/pricing.mdx # ja/tutorials/partner-nodes/runway/video-generation.mdx # ko/tutorials/partner-nodes/kling/kling-3-0.mdx # ko/tutorials/partner-nodes/pricing.mdx # ko/tutorials/partner-nodes/runway/video-generation.mdx # tutorials/partner-nodes/runway/video-generation.mdx # zh/tutorials/partner-nodes/kling/kling-3-0.mdx # zh/tutorials/partner-nodes/pricing.mdx # zh/tutorials/partner-nodes/runway/video-generation.mdx
…ename casing The merge with origin/main dropped 12 built-in-nodes nav entries x 4 locales (48 total), orphaning existing pages and leaving 16 empty nav groups. Restore them at their original positions, using on-disk filename casing (e.g. CLIPTextEncodeSD3) so the links also work on case-sensitive build environments.
- kling-3-0: replace dead api_kling_v3_i2v template link with api_kling_o3_i2v - wan2_2: render mp4 example output with <video controls> instead of <img> - cosmos-predict2-t2i, basic, controlnet: convert remaining HuggingFace resolve/main links to blob/main per the tutorial standard - seedance-2-0: align utm_campaign with the page stem - hunyuan-video: drop two cloud cards that lacked a template param - standardize card titles to 'Run on Comfy Cloud' (11 files) - remove remaining prose em dashes across 24 files (placeholders in tables and quoted example prompts intentionally kept)
… with English - Rewrite pages still carrying the chunked-translation duplication (translated copy plus untranslated English appended): qwen-image, krea-2, ideogram-v4, flux-1-kontext-dev, flux-1-controlnet (zh), newbie-image-exp-0-1, z-image-turbo - Restore reve-image workflow content (10 cards) deleted in ja/zh/ko - Add missing Z-Image-Turbo text-to-image workflow section (ja/ko) and ControlNet model subsection (zh) - Fix 8 broken double-slash HuggingFace URLs in ja kandinsky-5; rebuild kandinsky-5 (ja/zh/ko) to the current 13-card English structure - Convert remaining resolve/main links to blob/main across 32 files - Card-ify translations lagging the English structure: ace-step-v1-5, triposplat, gemma4, qwen3, qwen3_5, fun-control, ltxv, hunyuan-video, fun-camera, wan-move, qwen-image-2512, wan-ati, vace (zh) - Add missing boogu-image-0.1 and kling-3-0 translations (ja/zh/ko) - Fix locale-prefixed links in krea-2 (/ja/ /zh/ /ko/) - Resync translationSourceHash for PR-scoped pages
- SPEC.md: replace hardcoded local absolute paths with the sibling-repo convention used by the audit script - audit_workflows.py: abort --fix when the workflow_templates index is unavailable instead of deleting Example output sections; fix block boundary regex to match CJK bold headings - snippets ja/zh/ko faq: replace leftover 'API node' wording with the current Partner Nodes terminology; restore EOF newlines
Commit 2a3e669 regrouped the Partner Nodes sidebar by modality (Image / Video / 3D / Audio / LLM, localized per locale), but the local merge of origin/main (2a31fc9) silently reverted it to vendor grouping alongside the built-in-nodes entry drop. Splice the modality-grouped sections back for all four locales. This also: - restores ko/tutorials/partner-nodes/tripo/tripo-p1 (missing from main's ko nav) - drops a bogus 'ko/tutorials/...' entry that lived inside the ja tree All 208 page paths verified to exist on disk case-sensitively; no non-partner-nodes navigation entries changed.
Structural scan of all PR translations against current English flagged content loss/duplication in 11 pages x 3 locales: - seedance-2-0: add 2 missing Mini workflow preview images - ltx-2-3: add missing per-template ### sections, un-stack misplaced preview images, revert a bold line mistranslated as a heading - wan2-2-fun-control (ja/zh), hidream-i1 (zh), seedvr2 (zh/ja): detach headings that got glued onto the preceding list item - wan2_2: replace <img> pointing at an .mp4 with <video controls> - qwen-image-2512 (ko/zh): add missing Qwen Image 2512 section with its preview images; drop leftover inline <a> button in zh - fun-camera (ko): remove 2 duplicated preview images - image-to-image (zh), upscale (zh): restore 'What is...' intro sections lost in retranslation - text-to-image (zh): inline the missing HF model link (pre-existing) - align utm_campaign in seedance-2-0 translations with the page stem All 33 files now match English on headings/cards/images/link counts; hashes resynced.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Standardize all tutorial pages across video/, flux/, image/, 3d/, audio/, utility/ and partner-nodes/ to follow the new documentation conventions.
Changes
Structural
<a>tags with Mintlify<CardGroup cols={2}>+<Card>components for workflow downloads, model links, and input materialsRun in Comfy Cloudcards withutm_source=docs&utm_medium=referral&utm_campaign={campaign}paramsDownload Workflowcards linking to GitHub blob URLsURLs
resolve/maintoblob/main(file detail pages)Writing style
i18n
/snippets/{lang}/)/{lang}/interface/...)Scope
Files Changed
290 files changed, 4839 insertions(+), 2871 deletions(-)