Skip to content

chore: enforce the structure checks for es, now a published locale - #208

Merged
comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:chore/es-published-structure-check
Oct 26, 2026
Merged

comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:chore/es-published-structure-check

Conversation

@lin-bot23

Copy link
Copy Markdown
Contributor

What

es is now a locale the docs site actually publishes (docs#2107 added the Spanish built-in node reference, docs#2112 completed the Spanish site), but check_doc_structure.py still treated it as translated-but-not-rendered:

# Languages the documentation site publishes; other locales are translated in
# this repository too but are not rendered, so they are reported, not enforced.
ENFORCED_LANGS = ("ja", "zh", "ko")

So a Spanish page with a broken heading level, a missing section or a wrong "Edit on GitHub" link is repaired silently in --fix mode and never counted as a violation, while the same defect in ja/zh/ko fails the check.

Change

  • .github/scripts/check_doc_structure.py — ENFORCED_LANGS = ("ja", "zh", "ko", "es"), comment updated.
  • docs-generation/scripts/sync_to_comfy_docs.py — comment-only: the group-label tuple is already (EN, zh, ja, ko, es), the two comments still said four locales.

Nothing else needed: the sync side already publishes es (BUILTIN_ES, "page_prefix": "es/built-in-nodes", lang_idx: 4, DEFAULT_GROUP_ES, and all 28 CATEGORY_TO_GROUP entries carry the Spanish label).

Verification

check result
python3 .github/scripts/check_doc_structure.py (full tree, es enforced) 0 repaired, 0 defect(s) found — the existing es corpus already conforms
same, --changed-only --base origin/main 0 repaired, 0 defect(s) found
python3 .github/scripts/check_md_format.py (full tree) 0 errors, 125 warnings — unchanged

Enabling the rules therefore does not require any doc change today; it only means Spanish defects become enforcement-level from now on.

The docs site publishes Spanish (docs#2107 added the built-in node reference,
docs#2112 completed the locale), but the structure checker still treated es as
translated-but-not-rendered, so Spanish defects were never enforcement-level.
The existing es corpus is already clean (full-tree scan: 0 defects with es
enforced), so turning it on does not require doc changes.

Also updates the stale 'EN, zh, ja, ko' comments in sync_to_comfy_docs.py to
the five-locale tuple it actually builds.
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

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: a3667512-b1ed-43c3-b746-001a22bcbfeb
Commits

Reviewing files that changed from the base of the PR and between 24776d2 and 3aa811c.

Files selected for processing: 2
  • .github/scripts/check_doc_structure.py
  • docs-generation/scripts/sync_to_comfy_docs.py

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

Walkthrough

Spanish is now included in document-structure enforcement. The sync script’s category-map comment and parameter documentation also include Spanish.

Changes: Spanish locale support

Layer / File(s) Summary
Enforcement and locale documentation
.github/scripts/check_doc_structure.py, docs-generation/scripts/sync_to_comfy_docs.py
The checker includes Spanish in its enforced locales. The sync script’s category-map comment and parameter documentation list Spanish. The sync script’s executable behavior is unchanged.

Suggested reviewers: comfyui-wiki

Priority: Low

Merge Risk: Minimal · up to 3aa81

No actionable merge-blocking risk remains.

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)
  • Create a new PR
✨ Simplify code
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@coderabbitai
coderabbitai Bot requested a review from comfyui-wiki October 26, 2026 12:09
@comfyui-wiki
comfyui-wiki merged commit 2d2181f into Comfy-Org:main Oct 26, 2026
5 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 26, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants