해결하려는 문제 (Problem)
문서 정합성 문제(요약 절단, 깨진 링크, frontmatter 누락, 제목 레벨 건너뜀, 관련소스 불일치)를 그동안 수작업 스크립트로 찾아 정비해 왔습니다(#707, #716, #719, #720, #721, #722, #723). 같은 유형이 문서 추가·변환 때마다 재발할 수 있는데, 기여자가 제출 전에 스스로 점검할 표준 수단이 없습니다.
제안 (Proposal)
기여자용 로컬 검사 스크립트 docs-lint 를 저장소 scripts/에 추가하는 것을 제안합니다.
- 표준 라이브러리만 사용하는 파이썬 단일 파일(103줄), 의존성·설치 불필요:
python3 scripts/docs_lint.py .
- 검사 5종: L1 요약 말줄임(문장 단위 발췌 규칙), L2 깨진 상대링크, L3 frontmatter(title 등), L4 제목 레벨 건너뜀, L5 관련소스 실소스 대조(
--src로 소스 저장소 지정 시)
- 오탐 방지 내장: 렌더링 사이트에서는 정상인 링크 패턴(상위 섹션 images/ 참조 등)을
L2-siteok로 분류해 제외 — 과거 link-check CI가 오탐으로 비활성화된 것으로 알고 있어, CI 강제가 아닌 로컬 도구 + (선택) 수동 실행 워크플로로 포지셔닝했습니다
현재 main 기준 실측 결과
| 규칙 |
건수 |
비고 |
| L1 요약 말줄임 |
1 |
egovframe-runtime/intro/overview.md (#720은 common-component만 정비) |
| L2 깨진 링크 |
13 |
#723 목록과 정확히 일치 (도구가 같은 결과 재현) |
| L2-siteok |
143 |
사이트 렌더 정상 — 오탐으로 자동 분류·제외 |
| L3 frontmatter |
2 |
egovframe-runtime/intro.md 등 |
| L4 제목 레벨 |
49 |
대부분 egovframe-runtime — #719와 같은 방식의 후속 정비 가능 |
기여 의사
- 수용해 주시면
scripts/docs_lint.py + 사용법 문서를 PR로 제출하겠습니다
- L4 49건(runtime 문서 제목 레벨)도 #719와 동일한 방식의 정비 PR로 이어가겠습니다
스크립트 전문은 수용 시 PR로 제출하겠습니다 (103줄, 표준 라이브러리만 사용).
해결하려는 문제 (Problem)
문서 정합성 문제(요약 절단, 깨진 링크, frontmatter 누락, 제목 레벨 건너뜀, 관련소스 불일치)를 그동안 수작업 스크립트로 찾아 정비해 왔습니다(#707, #716, #719, #720, #721, #722, #723). 같은 유형이 문서 추가·변환 때마다 재발할 수 있는데, 기여자가 제출 전에 스스로 점검할 표준 수단이 없습니다.
제안 (Proposal)
기여자용 로컬 검사 스크립트
docs-lint를 저장소scripts/에 추가하는 것을 제안합니다.python3 scripts/docs_lint.py .--src로 소스 저장소 지정 시)L2-siteok로 분류해 제외 — 과거 link-check CI가 오탐으로 비활성화된 것으로 알고 있어, CI 강제가 아닌 로컬 도구 + (선택) 수동 실행 워크플로로 포지셔닝했습니다현재 main 기준 실측 결과
기여 의사
scripts/docs_lint.py+ 사용법 문서를 PR로 제출하겠습니다스크립트 전문은 수용 시 PR로 제출하겠습니다 (103줄, 표준 라이브러리만 사용).