docs: 문서 규칙 중복 제거 및 Markdown 가독성 기준 정리#66
Merged
Conversation
1. 문서 가독성을 위한 Markdown 가독성 규칙을 추가하였습니다. 2. 기존 방식에서 중복 제거가 제대로 이루어지지 않아, 조금 더 구체적으로 중복 제거와 관련된 전/후처리 규칙을 명시했습니다. 3. 문서화 시 AGENTS -> 상위 README -> 하위 README 흐름으로 참조하도록 가이드에 명시하였습니다. 4. 기존 Markdown 파일들에 남아있는 중복 포인트들을 더 제거하였습니다.
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
1 participant
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.
📝 Part (해당되는 것만 체크)
#️⃣ 연관된 이슈
No response
🔎 작업 내용
1. 주요 변경 사항 요약
docs/README.md와 작업 경로까지 내려가는 동안 추가로 마주치는 디렉토리README.md를 순서대로 확인하도록 기준 정리README.md및 템플릿에 반복되지 않도록 중복 문구 제거2. 상세 내용 (선택)
1. 문서 작업 진입 규칙을 정리하였습니다.
AGENTS.md에 다음 기준을 반영하였습니다.docs/README.md를 먼저 확인README.md를 순서대로 확인하도록 기준 반영2. 전역 규칙과 하위 문서의 중복을 제거하였습니다.
README.md나 템플릿에 다시 복제하지 않도록 규칙을 추가하였습니다.3. Markdown 가독성 기준을 전역 문서 규칙으로 추가하였습니다.
docs/README.md에 헤더 깊이, 리스트 형식, 문단 길이, 강조 사용, 구분선 사용에 대한 기준을 추가하여 가독성을 향상시키도록 하였습니다.3. 프롬프트 경로
4. 참조 문서 경로 (ADR, discussions, roadMap ...)
💬 집중 리뷰 요청
🧪 테스트 방법
1. 로컬 실행 방법
No response
2. 테스트 시나리오
No response
✅ PR 체크리스트
📈 이미지 / 캡처 (필요 시)
No response