Files
HMDesign/docs/sw/ai-docs-alignment-merge-2026-10-22.md
T
shkim4 7efb58ef12
Deploy Storybook / deploy (push) Successful in 1m19s
test(sw): approve the 5a40796 AI docs alignment merge baseline
Test-only approval commit after the 5a40796 main merge (sw-test-regression-
baseline section 9); no protected path changes, no Story change.
- approvedMainCommit 955581c -> 5a40796.
- public-api.approved.json kept: the public .d.ts files are byte-identical.
- docs/sw/ai-docs-alignment-merge-2026-10-22.md: change and verification.
2026-10-22 09:02:34 +09:00

54 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AI 문서 정합성 P1~P3·R1~R5 main 병합 검증 (2026-10-22)
main `d71db6c` 기준 AI 문서 정합성 점검(판정 PARTIAL)에서 찾은 필수 P1~P3와 권장 R1~R5를 문서만으로 맞추고 main에 반영한 기록입니다. 컴포넌트 소스·CSS·Story·Public API는 바꾸지 않았습니다.
## 1. 병합
| 항목 | 값 |
|---|---|
| P1~P3 Commit | `d03cc91` docs(sw): align viewer AI docs with open button, documents list and hover |
| R1~R5 Commit | `e267b1b` docs(ai): apply recommended doc alignment R1-R5 |
| main 병합 | `d71db6c` → `5a40796` (no-ff, `docs/sw-viewer-ai-docs-p1-p3`) |
| 승인 기준 Commit | 이 보고서와 같은 테스트 전용 Commit (`approvedMainCommit` `955581c` → `5a40796`) |
## 2. 수정 내용
| # | 파일 | 내용 |
|---|---|---|
| P1 | `packages/sw/ai/AI_USAGE.md` §0.4 | 뷰어 Hover `#266651` 면 제거 → 배경 변경 없이 글자·아이콘만 `#FFC600` |
| P2 | `packages/sw/ai/AI_USAGE.md` §0.2 | 파일 열기 = 로고 오른쪽 `onDocumentOpen` 버튼, 샘플 = `documents` 목록(`groups` 항목 아님) |
| P3 | `packages/sw/ai/COMPONENT_CATALOG.md` §9 | `SWViewerHeader` 배치·Open 위치(로고 옆, 목록 안 아님), `logoMenu` 호환용 표시 |
| R1 | `packages/sw/ai/COMPONENT_CATALOG.md` §9 | `SWViewerHeaderButton`: `custom` 안 32 × 40, `trailing` 띠 안 32 × 48(테두리·선 없음) |
| R2 | `packages/sw/ai/COMPOSITION_PATTERNS.md` §7 | 파일 열기 아이콘 = 아이콘 자체 검정 외곽선만, 별도 테두리·배경 면 없음 |
| R3 | `packages/sw/ai/VIEWER.md` §2 | 아이콘 영역 16 × 16, 버튼 padding `0 12px 0 24px` |
| R4 | `docs/ai/MAINTAINING.md` §1 | SW `ai/`: `FOOTER.md` 포함 Markdown 8개, 예제 A~J 10개(G·I 포함)와 보조 파일 |
| R5 | `docs/ai/AI_GUIDE.md` | center-graphic 진입점 `/reference`(참고 데모)·`/style.css` — `npm run sync:ai-docs`로 4개 패키지 사본 반영 |
대조한 코드: `SWViewerHeader.tsx`(Open 버튼·문서 목록 `showOpen={false}`·`logoMenu` 주석), `sw-viewer.css`(Hover 글자색, `__open` padding, `__open-icon` 16px, `data-icon-only="always"` 32 × 40, `trailing` 띠 stretch), `packages/center-graphic/package.json` exports.
`sync:ai-docs`가 LF checkout인 `packages/sw/ai/` 사본에 CRLF를 쓰므로 두 사본의 줄바꿈을 LF로 되돌린 뒤 Commit했습니다(내용 동일, `check:ai-docs`는 줄바꿈 무시).
## 3. 승인 기준 갱신 (`sw-test-regression-baseline-2026-10-20.md` §9)
- `approvedMainCommit`: `955581c` → `5a40796`(테스트 전용 Commit, 보호 경로 변경 없음).
- `public-api.approved.json` 유지: 공개 `.d.ts`가 승인 빌드와 바이트 동일. Story 추가·제거·이동·태그 변경이 없어 다른 승인 목록은 바꾸지 않았습니다.
## 4. 검증 결과 (Node 22.23.2, `npm run build-storybook` 후, 증거는 저장소 밖 임시 폴더)
| 검사 | 결과 |
|---|---|
| `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 |
| Public API Guard | 7/7 PASS |
| `check:ai-docs` · `ai-docs.check.mjs` | PASS · 46/46 PASS |
| 공유 사본(AI_GUIDE·AGENTS_SNIPPET × 4) | 원본과 동일(줄바꿈 제외) |
검사 실행 시 `dist/build-info.json`의 `dirty`는 `true`였습니다. 원인은 아직 Commit 전인 이 테스트 전용 변경(`storybook-inventory.mjs`)뿐이며 제품 소스는 `5a40796`과 같습니다.
## 5. 재실행하지 않은 항목
- 문서만 바뀌어 Typecheck, Viewer·Header·Footer·Popup 기능 테스트, 소비 프로젝트 빌드는 다시 실행하지 않았습니다.
- 남은 문서 항목(이번 범위 밖): `packages/sw/ai/AI_USAGE.md` 문서 표의 examples 설명이 A~F·H만 적고 G·I·J를 적지 않습니다.