Comfy-Org/docs

Comfy‑Org/docs란 무엇인가요?

이 저장소에는 AI 이미지 생성 파이프라인(예: Stable Diffusion)을 구축하기 위한 시각적 노드 기반 인터페이스인 ComfyUI의 공식 문서 사이트가 포함되어 있습니다. 문서는 MDX 파일을 다국어 웹사이트(https://docs.comfy.org/)로 렌더링하는 정적 사이트 생성기인 Mintlify로 구축됩니다.

핵심 목적

사용자 대상 문서를 구성하는 소스 Markdown/MDX 파일을 저장합니다.
변경 사항을 로컬에서 미리보기하는 스크립트를 제공합니다(npm i && npm run dev).
OpenAI 호환 번역 모델을 사용하여 영어 문서를 여러 언어(중국어, 일본어, 한국어 등)로 자동 번역합니다.
내장 노드에 대한 문서를 별도의 Comfy-Org/embedded-docs 저장소와 동기화합니다.
OpenAPI 사양에서 API 참조 페이지를 생성합니다.

주요 기능 및 워크플로우

기능	작동 방식	중요성
로컬 미리보기	`npm run dev`가 MDX 파일을 렌더링하는 개발 서버를 시작합니다.	기여자가 병합 전에 변경 사항을 즉시 확인할 수 있습니다.
자동 i18n	`npm run translate`가 번역 API(OpenAI 호환)를 호출하고 번역된 MDX를 언어 폴더에 씁니다. front-matter의 해시가 파일이 최신인지 추적합니다.	수동 번역 없이 문서를 여러 언어로 동기화합니다.
용어집 및 용어 일관성	3계층 시스템(`preserve_terms`, `glossary/frontend`, `glossary/overrides`)이 번역 전반에 걸쳐 기술 용어를 일관되게 유지합니다.	다국어 문서에서 혼동되거나 모순된 용어를 방지합니다.
API 참조 생성	`npx @mintlify/scraping@latest openapi-file <path>`가 OpenAPI 사양을 MDX 엔드포인트 페이지로 변환합니다.	ComfyUI의 백엔드 서비스를 사용하는 개발자에게 최신의 검색 가능한 API 문서를 제공합니다.
리디렉션 안전성	파일 이름이 변경되면 PR은 `docs.json`에 `redirects` 배열을 포함해야 합니다. 누락되면 GitHub Action이 PR을 실패시킵니다.	재구성 후에도 이전 링크가 계속 작동하도록 보장합니다.
동기화 소유 파일 보호	특정 파일(예: `openapi‑v2.yaml`, 생성된 라우터 페이지)은 동기화할 때마다 자동 생성됩니다. 워크플로우는 이러한 보호된 경로를 편집하는 PR을 차단합니다.	자동 생성된 콘텐츠의 실수로 인한 덮어쓰기를 방지합니다.
기여 흐름	PR 열기 → Vercel이 https://docs.comfy.org/에 자동 배포 → 리뷰어가 병합.	문서 업데이트를 위한 간단하고 빠른 피드백 루프.

누가 사용해야 하나요?

ComfyUI 사용자: 설치 가이드, 노드 참조 또는 워크플로우 예제를 찾는 분.
개발자: OpenAPI 사양 또는 API 사용 예제가 필요한 분.
번역가: 새 언어를 추가하려는 분(이슈를 열면 저장소가 대량 번역을 자동으로 처리합니다).
기여자: 문서를 개선하거나, 튜토리얼을 추가하거나, 용어를 수정하려는 분.

시작하는 방법

저장소를 클론합니다.
npm i를 실행한 다음 npm run dev를 실행하여 로컬에서 사이트를 봅니다.
루트(영어) 또는 언어 하위 폴더에서 MDX 파일을 편집하거나 추가합니다.
준비가 되면 브랜치를 푸시하고 PR을 엽니다. 병합 후 Vercel이 변경 사항을 게시합니다.
새 언어가 필요하면 이슈를 엽니다. 관리자가 translation-config.json에 추가하고 대량 번역 스크립트를 실행합니다.

요약: Comfy‑Org/docs는 ComfyUI AI 워크플로우 도구의 다국어 문서를 위한 소스 코드 및 자동화 허브로, 간편한 로컬 미리보기, 자동 번역, API 참조 생성, 안전한 기여 프로세스를 제공합니다.