1) 현재 상태 요약
- VitePress 문서 사이트가 Cloudflare Pages에 배포되고 있음
Docs Quality CheckCI가 문서 빌드/markdown lint/link check를 수행- markdownlint는
치명 규칙(fail)+스타일 규칙(warning)이중 운영 - PR 템플릿과 pre-commit 훅으로 문서 품질 게이트를 강화
2) 배포/검증 흐름
- 작성자는 템플릿(
docs/templates/doc-template.md) 기반으로 문서 작성 - 로컬에서
npm run docs:build확인 - PR 생성 시 체크리스트 작성 (
.github/pull_request_template.md) - CI(
Docs Quality Check) 확인 main머지 후 Cloudflare 배포 로그 및 URL 확인
3) 주요 설정 파일
- 사이트 구성:
docs/.vitepress/config.mts - 문서 품질 CI:
.github/workflows/docs-quality.yml - Cloudflare 배포:
.github/workflows/deploy-cloudflare.yml - markdown 규칙(치명):
.markdownlint-critical.jsonc - markdown 규칙(스타일):
.markdownlint-style.jsonc - 로컬 훅:
.githooks/pre-commit
4) 알려진 운영 포인트
- markdownlint 스타일 규칙은 warning-only로 운영되어 PR 피로도를 낮춤
- link-check는 빌드 산출물(
docs/.vitepress/dist/**/*.html) 기준으로 검사 - Cloudflare 시크릿이 없으면 배포 step은 skip됨(실패 아님)
5) 다음 담당자 액션 아이템
- [ ] PR/배포 실패 사례를
docs/updates.md에 주간 단위로 기록 - [ ]
docs/guide/writing-template.md를 월 1회 업데이트 - [ ] 문서 사용량(조회수/검색유입) 기반으로 IA 개선 우선순위 재정의
- [ ] 필요 시 GitHub Pages 수동 워크플로우 정리(유지/폐기 결정)
6) 빠른 점검 명령어
bash
npm run docs:build
npm run lint:md
npm run lint:md:style