개요

아래 템플릿을 복사해서 작성하면 문서 품질과 배포 절차를 일관되게 유지할 수 있습니다.

1) 템플릿 복사

기본 템플릿 파일:

• docs/templates/doc-template.md

새 문서 작성 예시:

cp docs/templates/doc-template.md docs/guide/my-new-doc.md

2) 필수 메타데이터 작성

frontmatter 항목을 반드시 채웁니다.

• title
• description
• audience (입문/실무/운영)
• difficulty (하/중/상)
• last_updated (YYYY-MM-DD)

3) 네비게이션 연결

docs/.vitepress/config.mts에서 해당 문서를 적절한 사이드바 섹션에 추가합니다.

4) 로컬 검증

npm install
npm run docs:build

5) PR/배포 체크

• PR 템플릿 체크리스트 작성 (.github/pull_request_template.md)
• Docs Quality Check 통과 확인
• main 머지 후 Cloudflare 배포 로그 확인

복붙용 미니 템플릿

---
title: 문서 제목
description: 문서 한 줄 요약
audience: 입문
difficulty: 하
last_updated: 2026-05-01
---

## 개요

문서 목적 요약.

## 핵심 내용

### 1) 포인트 A

### 2) 포인트 B

## 체크리스트

- [ ] 링크 확인
- [ ] 최신화 날짜 갱신