chore: 기여자용 문서 정합성 검사 스크립트 scripts/docs_lint.py 추가 (#725) - #767
Open
EricSeokgon wants to merge 1 commit into
Open
chore: 기여자용 문서 정합성 검사 스크립트 scripts/docs_lint.py 추가 (#725)#767EricSeokgon wants to merge 1 commit into
EricSeokgon wants to merge 1 commit into
Conversation
#725에서 메인테이너가 제안한 대로 기여자가 제출 전 스스로 돌려볼 수 있는 로컬 검사 스크립트를 추가한다. 표준 라이브러리만 사용하는 파이썬 단일 파일이며 검사 5종(L1~L5)을 수행한다. CI 변경은 없고 실행은 전적으로 수동이다.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
변경 유형 (Type of Change)
변경 내용 (Description)
#725에서 말씀해 주신 대로 스크립트를 작성해 PR로 올립니다. 기여자가 제출 전에 스스로 돌려보는 로컬 검사 도구이며, 문서 파일은 하나도 건드리지 않습니다.
scripts/docs_lint.py1개 파일만 추가합니다 (119줄).…로 절단됨 (#716에서 지적된 문장 단위 발췌 규칙)title누락--src지정 시에만)관련 이슈 (Related Issues)
Refs #725
변경 영역 (Affected Areas)
egovframe-development/)egovframe-runtime/)common-component/)README, 설정 파일 등) —scripts/신규체크리스트 (Checklist)
title,url,menu,weight등을 검토했습니다. (문서 변경 없음)실행 결과 (현재 main 전수 검사)
157건 중 142건은
L2-siteok(정보성) 입니다../images/foo.png처럼 상위 섹션의images/를 참조하는 패턴은 Hugo 렌더링 사이트에서는 정상이고 GitHub 뷰에서만 깨져 보이므로, 오탐으로 보고하지 않고 따로 분류합니다. 과거 link-check CI가 이런 패턴 때문에 소음이 컸던 점을 반영한 설계입니다.실제로 확인이 필요한 것은 15건이며, 전부 수동으로 실존 여부를 대조했습니다(오탐 0건).
egovframe-runtime/intro.md→./presentation-layer/uxui-controller-component.md(해당 파일 없음), foundation-layer·batch-layer 4개 문서 →../../runtime-example/...(runtime-example/디렉토리 자체가 없음)egovframe-runtime/intro.mdfrontmatter 없음common-component/user-authentication/find-id-password.md—## 개요다음이#### 기능흐름(h2→h4)이번 PR은 스크립트 추가만 다루며 위 15건 수정은 포함하지 않았습니다. 필요하시면 별도 PR로 정리하겠습니다.
검증 (Validation)
import re, os, sys, glob, json, urllib.parse+collections.defaultdict)..md) 정상 완료, 종료 코드 0.--json출력 파싱 정상,--src경로 지정 시 L5 동작 확인.--src값 누락 → usage 출력 후 종료 코드 2.추가 참고 사항 (Additional Notes)
.github/workflows/에 변경이 없고, 워크플로에서 이 스크립트를 호출하지도 않습니다. 실행은 전적으로 기여자 수동입니다.merge-on-pr.yaml)의paths는**.md와 이미지 확장자만 대상으로 하므로,.py파일만 있는 이 PR은 워크플로가 트리거되지 않고 Open 상태로 남습니다. 말씀하신 대로 센터 확인 후 처리 부탁드립니다.--strict옵션을 후속 PR로 추가하겠습니다. 이번에는 제안 범위대로 두었습니다.