Files
HMDesign/docs/sw/sw-doc-alignment-merge-2026-10-21.md
T
shkim4 2d5d2d9848
Deploy Storybook / deploy (push) Successful in 1m7s
test(sw): approve the c73f043 SW doc alignment merge baselines
Test-only approval commit after the c73f043 main merge (sw-test-regression-
baseline section 9); no protected path changes, no Story change.
- approvedMainCommit c1a69a4 -> c73f043.
- public-api.approved.json from the clean c73f043 build: 170 exports, 42
  declaration files and the manifest kept; only comment changes in
  SWRecentFiles / home-menu types / viewer types .d.ts.
- docs/sw/sw-doc-alignment-merge-2026-10-21.md: changes and verification.
2026-10-21 17:48:31 +09:00

4.2 KiB

SW 문서 정합성 6건 수정 main 병합 검증 (2026-10-21)

main 646fb60 기준 문서·패키지 정합성 검증에서 찾은 불일치 6건을 문서와 주석만으로 맞추고 main에 반영한 기록입니다. 컴포넌트 로직·Public Props·디자인·Story는 바꾸지 않았습니다.

1. 병합

항목 값
작업 Commit 8127cc7 docs(sw): AI 문서·주석을 2026-10-21 구현에 맞춤
main 병합 646fb60 → c73f043 (no-ff, fix/sw-design-review-2026-10-21)
승인 기준 Commit 이 보고서와 같은 테스트 전용 Commit

2. 수정 내용

  1. SWViewerHeader 두 가지 구성: VIEWER.md §2.1 신설(기본 / trailing 맨 끝 SWHeaderWindowControls showWindowMove={false} 최소화·닫기 버전). VIEWER.md·AI_GUIDE.md·AI_USAGE.md §0.3·COMPONENT_CATALOG.md·COMPOSITION_PATTERNS.md의 "뷰어에 SWHeader 부품을 섞지 않음" 규칙에 이 예외를 명시했습니다.
  2. 최근파일: COMPONENT_CATALOG.md·DESIGN_RULES.md — 최대 3개, 미리보기 제목 previewTitle 또는 path + 파일명, 본문은 갈색 #62533D 면 가운데 빨간 금지 표시 #FF0000, preview·renderPreview는 받기만 하고 렌더링하지 않음.
  3. 패키지 README Storybook 절: 40개(기본 표시 14 + verification 26)와 현재 Story 이름.
  4. collapseBelow·iconOnlyBelow: types.ts JSDoc·VIEWER.md·AI_GUIDE.md — px Breakpoint가 아니라 실측 공간 부족 단계의 대상·순서(아이콘만 → 값이 큰 것부터 More, 같은 값은 오른쪽 먼저). 뷰어 파일 열기는 onDocumentOpen 버튼(logoMenu는 호환용)으로 함께 정정.
  5. sw-header-usage.md: 현재 Story 구성·개수(기존 문단은 당시 기록으로 표시), 1800/1180/… More 기준은 760px 미만에만 적용, 속성Bar의 편집하지 않는 값은 <output>.
  6. 주석: SWHeader.tsx(760px 이상에서도 타이틀 유지), SWRecentFiles.tsx·home-menu types.ts(미리보기 미렌더링).

AI_GUIDE.md는 npm run sync:ai-docs로 4개 패키지 ai/ 복사본에 반영했습니다.

3. 승인 기준 갱신 (sw-test-regression-baseline-2026-10-20.md §9)

  • public-api.approved.json: 깨끗한 c73f043 빌드(build-info.json dirty false)에서 --snapshot. 170개 Export(값 64 + 타입 106)·42개 선언 파일·manifest 유지. 바뀐 값은 approvedCommit과 주석만 바뀐 components/sw-home-menu/SWRecentFiles.d.ts·components/sw-home-menu/types.d.ts·components/sw-viewer/types.d.ts의 SHA-256입니다(소스 diff에 주석 외 변경 없음).
  • approvedMainCommit: c1a69a4 → c73f043 (테스트 전용 Commit, 보호 경로 변경 없음). Story 추가·제거·이동·태그 변경이 없어 다른 승인 목록은 바꾸지 않았습니다.

4. 검증 결과 (Node 22.23.2, npm run build-storybook 후, 증거는 저장소 밖 임시 폴더)

검사 결과
Public API Guard (새 Snapshot) 7/7 PASS (170 Export 유지)
Typecheck (npm run typecheck:sw) 오류 0
check:ai-docs, ai-docs.check.mjs PASS, 46/46 PASS
AI 예제 12개 타입 검사(빌드된 @hm-design/sw 타입, 임시 폴더) 오류 0
npm run build-storybook 성공
home-menu-integration 23/23 PASS
overview / overview overlays 53/53, 20/20 PASS
storybook-unused-removal (Source Guard) 94/94 PASS

5. 재실행하지 않은 항목

  • 제품 동작이 바뀌지 않아 기존 Viewer·Header 기능 테스트, Footer·Popup 테스트, 소비 프로젝트 빌드(integrated-consumer·ai-template-consumer)는 다시 실행하지 않았습니다.
  • detail-buttons: 기존 102/122(실패 20건은 baseline.json에 현재 Story(overview·k-guide) 키가 없어 생기는 비교 불가, 같은 빌드로 새 기준을 찍으면 122/122)는 다시 분석하지 않았고 baseline.json·baseline-story-ids.json은 수정하지 않았습니다. 기준 갱신은 별도 승인 후 ① 현재 빌드에서 baseline 모드로 새 기준을 찍어 승인하거나 ② 비교 기준 Commit(예: a25d2b3) Storybook으로 기준을 찍은 뒤 현재 빌드를 verify하는 방법 중 하나로 합니다.