Skip to content

fix(docs): 문서 사이트 배경 누락과 레이아웃·문구 정리 - #323

Open
Yeom-JinHo wants to merge 3 commits into
devfrom
fix/docs-ui-jinho
Open

fix(docs): 문서 사이트 배경 누락과 레이아웃·문구 정리#323
Yeom-JinHo wants to merge 3 commits into
devfrom
fix/docs-ui-jinho

Conversation

@Yeom-JinHo

Copy link
Copy Markdown
Member

Changes

1. 스크롤 시 본문이 navbar를 관통하던 문제 (핵심)

원인은 --side-color-background-default선언은 되어 있으나 값이 비어 있는 것입니다. 테마 브릿지는 --color-background-default를 가리키는데 tokens.json은 같은 값을 color.background.base로 정의합니다. CSS 변수는 정의가 없어도 빈 값으로 조용히 해석돼 빌드·테스트를 통과했고, navbar 배경이 투명해졌습니다.

계약 불일치는 @sipe-team/tokens에서 고쳐야 하므로, 여기서는 값 레이어를 fallback으로 두어 우회합니다. 시맨틱 토큰이 정상화되면 fallback은 자동으로 빠집니다.

--ifm-navbar-background-color: var(--side-color-background-default, var(--color-background-base));

2. 크롬과 코드 표면 정리

  • navbar 하단 경계선 추가 — 없어서 사이드바 세로선이 만날 가로선 없이 허공에서 시작했습니다
  • 로고를 사이드바 항목과 같은 20px 축에 정렬 (기존 clamp()는 뷰포트에 따라 어긋났습니다)
  • 코드블록 배경·radius를 토큰에 맞춤 — prism이 인라인 스타일로 #1e1e1e를 주입해 --ifm-pre-background를 덮고 있었습니다
  • 사이드바 글자 크기를 한 단계 낮추고 활성 항목에 액센트 바 추가, 목차 인라인 코드의 배경 제거

3. 모바일에서 홈 카드가 맞붙던 문제

카드는 infima 그리드의 col을 쓰는데 col은 좌우 padding만 있고 세로 여백이 없습니다. 996px 이하에서 세로로 쌓이면 간격이 0이 됩니다. rowrow-gap을 주어 가로 간격과 같은 32px를 맞췄습니다. 한 줄에 들어가는 동안에는 발동하지 않아 데스크톱은 그대로입니다.

4. 한국어 문구 통일

사이트 로케일은 en 하나이고 문서도 모두 영어인데, 화면에 보이는 문구 두 곳만 한국어였습니다. 홈 히어로 부제는 같은 파일의 SEO description이 이미 영어라 한 파일 안에서도 어긋나 있었습니다.

Visuals

스크린샷 2026-08-11 오후 10 37 03 스크린샷 2026-08-11 오후 10 36 48

Checklist

  • Have you written the functional specifications?
  • Have you written the test code?

Yeom-JinHo and others added 3 commits August 11, 2026 22:18
navbar가 페이지와 같은 배경을 쓰면서 경계선도 그림자도 없어, 사이드바의
세로 구분선이 만날 가로선 없이 허공에서 시작했다. navbar에 하단
경계선을 넣어 둘이 만나게 하고, 로고를 사이드바 항목과 같은 20px 축에
맞춘다. 기존 clamp() 값은 뷰포트에 따라 이 축에서 어긋났다.

배경색은 시맨틱 토큰이 아니라 값 레이어로 우회한다.
--side-color-background-default는 선언되어 있으나 값이 비어 있다.
브릿지가 --color-background-default를 가리키는데 tokens.json은 같은 값을
color.background.base로 정의하기 때문이다. 이 계약 불일치는
@sipe-team/tokens에서 따로 고쳐야 하므로, 그때까지 값 레이어를 fallback으로
둔다. 이대로 두면 페이지와 navbar에 배경이 아예 없어 sticky navbar 뒤로
본문이 비친다. 시맨틱 토큰이 정상화되면 fallback은 자동으로 빠진다.

코드블록은 prism 테마가 인라인 스타일로 #1e1e1e를 주입해
--ifm-pre-background를 덮고 있었다. !important 대신 테마의
plain.backgroundColor에 토큰을 넣어 표면 색을 디자인 시스템으로
되돌리고, 모서리도 카드·프리뷰와 같은 8px로 통일한다.

사이드바는 본문과 같은 글자 크기라 위계가 평평했다. 한 단계 줄이고
활성 항목에 굵기와 액센트 바를 준다. 목차의 인라인 코드는 채워진
상자로 렌더돼 주변 항목과 경쟁하므로 표면을 걷어낸다.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BhY4G6FYoATMmEd842BSVa
카드는 infima 그리드의 col을 쓰는데, col은 좌우 padding만 가지고 세로
여백이 없다. 데스크톱에서는 그 좌우 padding이 카드 사이 32px를 만들지만,
996px 이하에서 col이 전체 폭이 되어 세로로 쌓이면 간격이 0이 된다.

row에 row-gap을 주어 가로 간격과 같은 32px를 맞춘다. 카드가 한 줄에
들어가는 동안에는 발동하지 않으므로 데스크톱 레이아웃은 그대로다.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BhY4G6FYoATMmEd842BSVa
사이트 로케일은 en 하나이고 문서도 모두 영어인데, 화면에 보이는 문구
두 곳만 한국어였다. 홈 히어로의 부제는 같은 파일의 SEO description이
이미 영어라 한 파일 안에서도 어긋나 있었다.

- 히어로 부제 → "The design system for Sipe products"
- Badge 문서의 Usage 예제 텍스트 → "Sipe"

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BhY4G6FYoATMmEd842BSVa
@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
side Ready Ready Preview Aug 11, 2026 2:15pm
side-docs Ready Ready Preview Aug 11, 2026 2:15pm

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)
  • main
  • release/v1

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a69522cb-e69f-47d1-8292-f79a86f60a96

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@Yeom-JinHo Yeom-JinHo changed the title Fix/docs UI jinho fix(docs): 문서 사이트 배경 누락과 레이아웃·문구 정리 Aug 11, 2026
@changeset-bot

changeset-bot Bot commented Aug 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2562d51

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov

codecov Bot commented Aug 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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