Skip to content

docs : README 구성을 기준 형식에 맞게 정리 - #332

Merged
xodn09 merged 1 commit into
releasefrom
docs/align-readme-structure
Oct 26, 2026
Merged

xodn09 merged 1 commit into
releasefrom
docs/align-readme-structure

Conversation

@azunox

@azunox azunox commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

변경 요약

  • 배너 뒤의 불필요한 구분선과 공통 섹션의 잘못된 제목 단계를 정리했습니다.
  • 관련 저장소·문서·라이선스 안내를 보완하고 공통 푸터를 적용했습니다.

기준: Type-Nu11/pingdom-api의 기본 브랜치 README.md

검증

  • 변경 범위에 맞는 lint, type check, build 또는 직접 검증을 수행했습니다.

  • 수행하지 않은 검증과 이유를 적었습니다.

  • git diff --check 통과

  • GitHub Markdown API 렌더링 통과: 공통 H2 14개, 표 6개, 푸터 구분선 1개 확인

  • 상대 링크·이미지 경로 5개를 Git 추적 트리와 대조

  • PR 브랜치를 GitHub 브라우저에서 확인: 배너 실제 로딩, 공통 H2 14개, H1 없음, 구분선 1개, 마지막 푸터 확인

  • README만 변경하여 애플리케이션 테스트·빌드·Docker 검증은 실행하지 않았습니다.

Web API 계약

  • Web API 영향 없음
  • 영향 operation을 아래에 METHOD /path 형식으로 모두 기록했습니다.
  • 계약 변경 시 docs/web-api-contract-matrix.csv의 schema, status, issue, canonical 상태, last_verified를 갱신했습니다.
  • 제거·legacy API를 구현 완료로 표시하지 않았습니다.
  • 파괴적 mutation의 경고, 사유 입력, 대상 재입력 등 확인 수준을 검토했습니다.

영향 operation:

  • 없음

관련 이슈

  • 관련 이슈 없음. 조직 README 구성 정리 요청에 따른 문서 변경입니다.

@azunox azunox added the documentation Improvements or additions to documentation label Oct 26, 2026
@azunox azunox self-assigned this Oct 26, 2026
@xodn09
xodn09 merged commit 1d6c471 into release Oct 26, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants