문서 유지보수 전략

name: Docs Sync Check
on:
  pull_request:
    paths:
      - 'src/**'
      - 'docs/**'

jobs:
  check-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Check docs need update
        run: |
          # src/ 변경 시 관련 docs/ 변경 확인
          SRC_CHANGED=$(git diff --name-only origin/main | grep '^src/' || true)
          DOCS_CHANGED=$(git diff --name-only origin/main | grep '^docs/' || true)

          if [ -n "$SRC_CHANGED" ] && [ -z "$DOCS_CHANGED" ]; then
            echo "::warning::소스 코드가 변경되었지만 문서 업데이트가 없습니다."
            echo "관련 문서 업데이트가 필요한지 확인하세요."
          fi

#!/bin/bash
# .husky/pre-commit
# API 라우트 변경 시 API 문서 갱신 확인

CHANGED=$(git diff --cached --name-only | grep 'src/api/')
if [ -n "$CHANGED" ]; then
  echo "⚠️ API 라우트가 변경되었습니다. docs/api/ 문서도 업데이트했는지 확인하세요."
fi

# 문서 freshness 정책
freshness:
  warn_after_days: 90      # 90일 미갱신 시 경고
  critical_after_days: 180  # 180일 미갱신 시 리뷰 필수
  exclude:
    - docs/adr/             # ADR은 의도적으로 변경하지 않음
    - docs/changelog.md     # 자동 생성

다음 문서와 현재 코드를 비교해서 불일치를 찾아줘.

문서: [문서 내용]
코드: [관련 코드 파일들]

확인할 것:
1. 문서의 API 설명이 실제 코드와 일치하는가
2. 문서의 설정 예시가 현재 설정과 일치하는가
3. 문서에서 언급하는 파일/함수가 실제 존재하는가
4. 삭제/이름 변경된 항목이 문서에 남아있는가

# .github/workflows/docs-code-test.yml
name: Test Doc Code Examples
on:
  push:
    paths: ['docs/**']
jobs:
  test-examples:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Extract and test code blocks
        run: |
          # docs/ 내 ```bash 블록을 추출해 syntax 검증
          find docs -name '*.md' -exec grep -l '```bash' {} \; | \
          while read f; do
            echo "Checking: $f"
            # shellcheck으로 bash 문법 검증
            sed -n '/```bash/,/```/p' "$f" | \
            grep -v '```' | shellcheck -
          done