Documentation Need
packages/* 하위 22개 패키지 중 18개 패키지에 README.md가 없는 상태로 GitHub Package Registry에 배포되고 있습니다. 현재 README가 존재하는 패키지는 accordion, icon, reset, theme 4개뿐이며, 그 외 @sipe-team/* 패키지를 설치하는 사용자는 패키지 단위의 진입 문서를 전혀 참고할 수 없습니다ㅠㅠ
Proposed Changes
packages/* 하위에서 README가 없는 18개 패키지에 README.md를 추가
- 모든 README는 동일한 템플릿을 따르도록 셋업 (아래는 예시):
- 패키지 이름 + 한 줄 설명
- 설치 방법 (
pnpm add @sipe-team/<name>)
- 최소 사용 예시 (import + JSX)
- Props / API 요약 (가능한 경우 Storybook / Docusaurus 링크)
- 디자인 시스템 사이트로 돌아가는 링크
Target Audience
- GitHub Package Registry에서
@sipe-team/* 패키지를 설치해 사용하는 최종 사용자 / 개발자
- 패키지별로 빠르게 감을 잡고 싶은 신규 contributorr!!
Additional Context
- 참고 가능한 기존 README:
packages/accordion/README.md, packages/theme/README.md, packages/reset/README.md, packages/icon/README.md
Documentation Need
packages/*하위 22개 패키지 중 18개 패키지에README.md가 없는 상태로 GitHub Package Registry에 배포되고 있습니다. 현재 README가 존재하는 패키지는accordion,icon,reset,theme4개뿐이며, 그 외@sipe-team/*패키지를 설치하는 사용자는 패키지 단위의 진입 문서를 전혀 참고할 수 없습니다ㅠㅠProposed Changes
packages/*하위에서 README가 없는 18개 패키지에README.md를 추가pnpm add @sipe-team/<name>)Target Audience
@sipe-team/*패키지를 설치해 사용하는 최종 사용자 / 개발자Additional Context
packages/accordion/README.md,packages/theme/README.md,packages/reset/README.md,packages/icon/README.md