docs(packages): npm README 추가 및 문서 도메인 오타 수정 - #26
Merged
Conversation
계정명이 Bori-github이라 Pages 도메인은 bori-github.github.io인데 레포 전체가 boriguri.github.io를 가리키고 있었다. 전부 404다. 가장 문제가 되는 곳: - apps/zpl-core/package.json, apps/react-zpl/package.json의 homepage 이미 npm에 배포된 패키지의 "Homepage" 링크가 404로 간다 - docs/rspress.config.ts, docs/docs/index.mdx의 og:url SNS 공유 카드가 깨진다 - 루트 package.json, README.md Pages 설정의 html_url(https://bori-github.github.io/zpl-kit/)과 대조해 확인했고, 수정 후 문서 사이트 링크 8개가 모두 200을 반환하는 것을 확인함. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
두 패키지 모두 README 없이 npm에 배포되어 랜딩 페이지가 백지였다.
files: ["dist"]이지만 npm은 README를 항상 tarball에 포함하므로
추가만으로 페이지가 채워진다 (pack해서 확인함).
수록한 예제는 전부 실제로 실행해 검증했다:
- zpl-core: renderLabel, 렌더러 개별 호출, 커맨드 계층, 검증 에러
- react-zpl: 사용법, print(), 검증 에러 — 타입체크 + 런타임 둘 다
작성 중 확인한 사실들:
- 두 패키지가 같은 라벨에 대해 바이트 단위로 동일한 ZPL을 낸다
- fieldOrigin의 파라미터는 { offsetX, offsetY }다 ({ x, y }가 아님)
- 실제 출력에는 커맨드 사이에 \& 구분자가 들어간다
- zpl-core에는 engines 필드가 없어 Node 버전 요구사항을 적지 않았다
react-zpl README에 print() 사용법 경고를 넣었다. print()에 라벨을 감싼
컴포넌트를 <OrderLabel /> 형태로 넘기면 ^PWundefined가 조용히 생성된다.
print()가 넘겨받은 엘리먼트의 props에서 크기를 읽기 때문이고, 타입 검사에도
걸리지 않는다. 동작하는 형태는 OrderLabel({...}) 호출이거나 ZplLabel
엘리먼트를 직접 넘기는 것이며, 데모 4개도 전자를 쓰고 있다.
API 자체를 고치는 건 이 PR 범위 밖이라 문서로만 표시한다.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Bori-github
added
fix
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
1 task
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.
개요
두 npm 패키지의 README(랜딩 페이지)를 추가하고, 문서 사이트 도메인 오타를 함께 바로잡습니다.
변경 내용
docs(packages)— README 추가apps/zpl-core/README.md—renderLabel, 노드 6종, 렌더러·커맨드 계층, 상수, 검증apps/react-zpl/README.md—ZplLabel.print(), 컴포넌트 7종, 검증print()에 래퍼 컴포넌트를 넘기면^PWundefined가 조용히 나오는 함정을 명시fix(docs)— 도메인 오타 수정boriguri.github.io→bori-github.github.io(README.md,package.json3곳,docs/docs/index.mdx,docs/rspress.config.ts)검증
renderCircle예제의 잘못된 2-인자 호출을tsc로 재현·수정 (1-인자)ZplElementContext)와 일치시킴 (인코딩 → 방향)format:check·lint(경고 0) 통과