Skip to content

docs: props 테이블 줄바꿈 깨짐 수정 및 ElementType 타입 표기 보존 - #636

Merged
Sh031224 merged 2 commits into
feature/4.0.0from
docs/props-table-text-wrap
Sep 8, 2026
Merged

docs: props 테이블 줄바꿈 깨짐 수정 및 ElementType 타입 표기 보존#636
Sh031224 merged 2 commits into
feature/4.0.0from
docs/props-table-text-wrap

Conversation

@Sh031224

@Sh031224 Sh031224 commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • props 테이블 이름 셀이 중간에 줄바꿈되던 문제 수정: CodeBlocksx를 받도록 하고 이름 셀에 word-break: keep-all 적용, 설명 아이콘에 flex-shrink: 0
  • MDX 본문을 overflow-wrap: anywhere로 바꿔 긴 토큰이 레이아웃을 밀어내지 않게 함
  • api-generator: 제네릭 인자가 붙은 ElementType<...>도 보존 타입으로 인식해 as prop 타입이 풀어져 표기되지 않도록 수정

배포 영향이 없는 docs / 스크립트 변경이라 마일스톤 없음.

Test plan

  • pnpm -F docs dev로 컴포넌트 문서의 props 테이블 렌더링 확인 (이름 셀 줄바꿈, 아이콘 크기)
  • pnpm build:apidocs/generated/api.json에서 as prop 타입이 ElementType<...>로 유지되는지 확인

Summary by CodeRabbit

  • 개선 사항
    • 문서 내 코드 블록과 인라인 코드에 사용자 지정 스타일을 적용할 수 있습니다.
    • 속성 표의 prop 이름이 셀 안에서 더 일관되게 표시되도록 줄바꿈 동작을 조정했습니다.
    • 긴 콘텐츠와 타입 표현의 줄바꿈 처리를 개선했습니다.
    • 제네릭 타입이 포함된 요소 타입이 API 문서 생성 과정에서 올바르게 인식됩니다.

- CodeBlock이 sx를 받도록 해 props 테이블 이름 셀을 keep-all로 유지하고
  설명 아이콘이 줄어들지 않게 고정
- MDX 본문은 overflow-wrap: anywhere로 긴 토큰이 레이아웃을 밀어내지 않게 함
- api-generator가 제네릭 인자가 붙은 ElementType<...>도 보존 타입으로
  인식해 as prop 타입이 풀어져 표기되지 않게 함

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@Sh031224 Sh031224 self-assigned this Sep 8, 2026
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 51 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

This review ran on the open-source allowance, not this organization's plan, because the pull request author doesn't have an assigned seat. Waiting won't change this — ask an organization admin to assign them a seat, or add seats in Billing if every seat is already assigned, then retry.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 1715d54a-a0a4-459a-9367-f243254910f9

📥 Commits

Reviewing files that changed from the base of the PR and between 1989f61 and 6f95ced.

📒 Files selected for processing (1)
  • docs/src/features/docs/components/mdx/code-block/index.tsx

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 6e78a61f-f833-4e89-b9a4-49f39f7d9110

📥 Commits

Reviewing files that changed from the base of the PR and between b4a9a0d and 1989f61.

📒 Files selected for processing (4)
  • docs/src/features/docs/components/mdx/code-block/index.tsx
  • docs/src/features/docs/components/mdx/mdx-render/style.ts
  • docs/src/features/docs/components/mdx/props-table/index.tsx
  • scripts/api-generator/src/resolver.ts

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


Walkthrough

MDX CodeBlock이 외부 sx 스타일을 인라인 및 블록 코드에 병합합니다. MDX 텍스트와 PropsTable의 줄바꿈 스타일을 조정합니다. API 생성기는 ElementType과 제네릭 타입의 기본 이름을 보존 타입으로 인식합니다.

Changes

MDX 코드 표시

Layer / File(s) Summary
CodeBlock sx 스타일 지원
docs/src/features/docs/components/mdx/code-block/index.tsx
CodeBlock의 Props가 WithSxProps를 사용합니다. 인라인 및 블록 코드가 전달된 sx 스타일을 기존 스타일과 병합합니다.
MDX 텍스트 줄바꿈 스타일
docs/src/features/docs/components/mdx/mdx-render/style.ts, docs/src/features/docs/components/mdx/props-table/index.tsx
MDX 콘텐츠의 overflow-wrapanywhere로 변경합니다. PropsTable의 prop 이름 코드에 wordBreak: 'keep-all'overflowWrap: 'initial'을 적용합니다.

API 생성기 타입 보존

Layer / File(s) Summary
보존 타입 판별
scripts/api-generator/src/resolver.ts
보존 타입 목록에 ElementType을 추가합니다. isPreservedType가 제네릭 인자를 제거한 기본 타입 이름도 검사합니다.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 1989f

This change improves MDX wrapping and prop-table code display while preserving generic ElementType annotations in generated API documentation. No current merge-blocking behavior or production-impact risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목은 props 테이블 줄바꿈 수정과 ElementType 타입 표기 보존이라는 주요 변경 사항을 정확히 요약합니다. 변경 범위와 직접 관련되고 구체적입니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 4…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/props-table-text-wrap

Comment @coderabbitai help to get the list of available commands.

@montage-web-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
@montage-ui/core 2.49 KB (0%)
@montage-ui/icon 3.96 KB (0%)
@montage-ui/lottie 68 B (0%)
@montage-ui/theme 156 B (0%)
@montage-ui/engine 324 B (0%)
@montage-ui/nextjs 149 B (0%)

docs 패키지는 @montage-ui/engine을 직접 의존하지 않아 WithSxProps
import가 빌드에서 실패했다. core가 export하는 SxProp으로 대체한다.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@montage-web-actions

Copy link
Copy Markdown
Contributor

🚀 Preview

Last commite6366d5
Preview URLhttps://dev-montage.wanted.co.kr/e6366d5

@Sh031224
Sh031224 merged commit 28250bb into feature/4.0.0 Sep 8, 2026
12 checks passed
@Sh031224
Sh031224 deleted the docs/props-table-text-wrap branch September 8, 2026 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant