Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.71 KB

File metadata and controls

52 lines (38 loc) · 2.71 KB

Agent guide — ComfyUI docs repo

English is the source of truth. Docs translation, CMS changelog sync, and Mintlify analytics are separate pipelines — do not mix them.

Skills

Skill Path Use when
docs-i18n-translate .cursor/skills/docs-i18n-translate/SKILL.md Translating MDX to ja/zh/ko, pnpm translate, glossary
docs-i18n-review .cursor/skills/docs-i18n-review/SKILL.md Reviewing translation quality, pnpm translate:review
cms-changelog-sync .cursor/skills/cms-changelog-sync/SKILL.md Strapi release notes, pnpm cms:prepare, pnpm cms:sync

Load the matching skill and its README before changing that pipeline.

Prose style (English MDX)

When writing or editing English documentation, follow .cursor/rules/docs-prose.mdc:

  • Avoid em dashes (—). They read as generic AI copy. Use periods, commas, colons, parentheses, or a second sentence instead.
  • Prefer short, direct sentences over stacked clauses joined by dashes.
  • Match the tone of surrounding pages: technical reference, not marketing blog.

Instead of: Comfy Cloud MCP is in public beta — APIs may change.
Prefer: Comfy Cloud MCP is in public beta. APIs may change while we iterate.

Instead of: **Discord** — #channel for questions.
Prefer: **Discord**: #channel for questions.

Page titles and descriptions (frontmatter)

Every MDX page's title and description frontmatter is what users see in search results and link previews. Generic titles ("Overview", "Tips") and vague or missing descriptions stop users from identifying page content before clicking. Follow .cursor/rules/docs-frontmatter.mdc for every new or edited page:

  • Title leads with the specific subject (model/tool name or feature); a bare generic word is not enough.
  • Description: 40 to 160 chars (target 120 to 155), states what the page covers, never duplicates the title, no marketing superlatives.
  • Quote the description value when it contains a colon-space sequence.
  • zh/ja/ko pages carry localized titles/descriptions conveying the same scope; sync them in the same commit as the EN change.

Reference docs

Topic Doc
Env / secrets .env.local.example
Docs i18n .github/scripts/i18n/README.md
CMS changelog .github/scripts/cms/README.md
Mintlify analytics .github/scripts/analytics/README.md