[PR #208] [MERGED] chore: enforce the structure checks for es, now a published locale #205

Closed
opened 2026-10-26 22:10:46 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/embedded-docs/pull/208
Author: @lin-bot23
Created: 10/26/2026
Status: ✅ Merged
Merged: 10/26/2026
Merged by: @comfyui-wiki

Base: main ← Head: chore/es-published-structure-check


📝 Commits (1)

  • 3aa811c chore: enforce the structure checks for es, now a published locale

📊 Changes

2 files changed (+4 additions, -3 deletions)

View changed files

📝 .github/scripts/check_doc_structure.py (+2 -1)
📝 docs-generation/scripts/sync_to_comfy_docs.py (+2 -2)

📄 Description

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.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/embedded-docs/pull/208 **Author:** [@lin-bot23](https://github.com/lin-bot23) **Created:** 10/26/2026 **Status:** ✅ Merged **Merged:** 10/26/2026 **Merged by:** [@comfyui-wiki](https://github.com/comfyui-wiki) **Base:** `main` ← **Head:** `chore/es-published-structure-check` --- ### 📝 Commits (1) - [`3aa811c`](https://github.com/Comfy-Org/embedded-docs/commit/3aa811c155c98efdfacf9518d335675f9996dfc8) chore: enforce the structure checks for es, now a published locale ### 📊 Changes **2 files changed** (+4 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `.github/scripts/check_doc_structure.py` (+2 -1) 📝 `docs-generation/scripts/sync_to_comfy_docs.py` (+2 -2) </details> ### 📄 Description ## 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: ```python # 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-26 22:10:46 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Comfy-Org/embedded-docs#205
No description provided.