Skip to content

docs: README 작성 및 stale 아키텍처 문서 정정#110

Merged
6-keem merged 1 commit into
mainfrom
docs/sync-architecture-docs
Jun 17, 2026
Merged

docs: README 작성 및 stale 아키텍처 문서 정정#110
6-keem merged 1 commit into
mainfrom
docs/sync-architecture-docs

Conversation

@6-keem

@6-keem 6-keem commented Jun 17, 2026

Copy link
Copy Markdown
Member

관련 이슈

Closes #109

변경 내용

오픈소스 공개에 맞춰 문서를 실제 코드와 일치시킨다.

  • README.md: 본문이 비어 있던 README를 작성 — 소개 / 주요 기능 / 설치 / 기술 스택 / 문서 / 기여 / 라이선스. 개발 절차는 CONTRIBUTING.md로 링크.
  • CLAUDE.md: Architecture 섹션을 실제 진입점 2개 구조로 정정.
    • 진입점 3개 → 2개 (Options Page 삭제됨)
    • Content Script 경로 src/content/index.tsxsrc/popover/index.tsx
    • Background 역할: Chrome alarm/notification 스케줄링 → chrome.identity OAuth 토큰 중개 + 문서 사이트 열기
    • ShadowRootContext 경로 src/lib/src/popover/lib/
  • .claude/rules/typescript.md: 동일하게 경로·메시지 패싱 설명 정정.

코드에는 dead code가 없음(빌드/엔트리/manifest 권한 모두 정리됨). 문서만 코드보다 뒤처져 있던 것을 맞춘다.

변경 유형

  • 🐛 버그 수정 (fix)
  • ✨ 기능 추가 (feat)
  • 📝 문서 (docs)
  • ♻️ 리팩터링 (refactor)
  • 🎨 스타일/포맷 (style)
  • ⚙️ 빌드/CI (chore, ci)

체크리스트

  • 이 PR과 연결된 이슈가 존재합니다.
  • 로컬에서 prettier 검사가 통과합니다. (문서만 변경 — 코드 빌드 영향 없음)
  • 변경 사항을 직접 검토했습니다.
  • CodeRabbit / 리뷰어 피드백을 반영할 준비가 되어 있습니다.

Summary by CodeRabbit

릴리스 노트

  • Documentation
    • README를 전체 개편하여 프로젝트 개요, 주요 기능, 사용자/개발자 설치 가이드, 기술 스택, 기여 정책을 추가로 제공합니다.
    • 개발자 문서의 아키텍처 설명을 확장하여 최신 구조 정보를 반영합니다.
    • 기술 규칙 문서의 구체적 예시를 업데이트합니다.

@6-keem 6-keem self-assigned this Jun 17, 2026
@github-actions github-actions Bot added the docs 문서 개선 또는 추가 label Jun 17, 2026
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md를 배지/썸네일 위주 구성에서 소개·기능·설치·기술 스택·문서·기여·라이선스 섹션을 갖춘 문서로 전면 재작성했습니다. CLAUDE.md 아키텍처 섹션과 .claude/rules/typescript.md의 예시를 실제 코드 구조(진입점, 경로, 백그라운드 역할)에 맞게 정정했습니다.

Changes

문서 정비

Layer / File(s) Summary
CLAUDE.md 및 TypeScript 규칙 stale 내용 정정
CLAUDE.md, .claude/rules/typescript.md
CLAUDE.md의 아키텍처 진입점을 src/popover/index.tsx로, ShadowRootContext 경로를 src/popover/lib/로, 백그라운드 역할을 OAuth 토큰 중개 및 문서 사이트 오픈으로 업데이트했습니다. 옵션 페이지 엔트리 포인트 서술은 제거되었으며, TypeScript 규칙 문서의 chrome 메시지 패싱 예시도 Google OAuth 토큰 발급으로 갱신되었습니다.
README.md 전면 재작성
README.md
소개(대시보드/자동 연속 재생/캘린더 동기화), 주요 기능 4종, 설치(사용자·개발자), 기술 스택(프론트엔드·확장 구성요소·데이터 캐시 TTL), 문서 링크, 기여 정책(1 PR = 1 Issue, Conventional Commits), Apache-2.0 라이선스 섹션으로 재구성되었습니다.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • hs-shell/dotbugi#95: 이 PR이 수정한 .claude/rules/typescript.md(Shadow DOM / ShadowRootContext / chrome 메시지 예시) 및 CLAUDE.md 아키텍처 섹션을 최초로 추가·정리한 변경으로, 동일한 섹션을 직접 수정합니다.
🚥 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 PR 제목은 README 작성 및 아키텍처 문서 정정이라는 주요 변경사항을 명확하고 간결하게 요약하고 있습니다.
Linked Issues check ✅ Passed PR의 모든 코드 변경사항이 Issue #109의 목표를 충족합니다: README 본문 작성, CLAUDE.md 아키텍처 정정, typescript.md 경로 업데이트가 모두 완료되었습니다.
Out of Scope Changes check ✅ Passed 모든 변경사항이 Issue #109의 범위 내에 있으며, 문서 정정만 포함되어 있고 불필요한 추가 변경은 없습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-architecture-docs

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 51-64: The heading hierarchy in the Installation section is
incorrect as h2 "설치" is followed directly by h4 headings for "사용자" and "개발자 (로컬
빌드)" instead of h3. Change both occurrences of "#### 사용자" and "#### 개발자 (로컬 빌드)"
to use three hash marks ("### 사용자" and "### 개발자 (로컬 빌드)") to maintain proper
heading hierarchy with h2 as the parent and h3 as the children.
- Around line 19-47: The markdown heading hierarchy is broken because h2
headings are followed directly by h4 headings without an intermediate h3 level.
Fix this by changing all four h4 headings (marked with ####) to h3 headings
(marked with ###): change "#### 할 일 대시보드" to "### 할 일 대시보드", "#### 자동 연속 재생" to
"### 자동 연속 재생", "#### Google 캘린더 연동" to "### Google 캘린더 연동", and "#### 강의 페이지
배지" to "### 강의 페이지 배지" to maintain proper markdown heading hierarchy.
- Around line 68-87: The heading hierarchy in the 기술 스택 section needs correction
and the skill icons image needs accessibility improvement. Change the heading
levels for both "Frontend" and "Extension (진입점 2개)" sections from h4 (####) to
h3 (###) to maintain proper semantic hierarchy under the h2 "기술 스택" heading.
Additionally, add descriptive alt text to the skill icons image that displays
the technology stack (React, TypeScript, Vite, Tailwind CSS) to improve
accessibility and document context.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4beda477-7b89-44df-bbb9-f173a40bf0cf

📥 Commits

Reviewing files that changed from the base of the PR and between 04e3be2 and b2c3ecd.

📒 Files selected for processing (3)
  • .claude/rules/typescript.md
  • CLAUDE.md
  • README.md

Comment thread README.md
Comment thread README.md
Comment thread README.md
@6-keem 6-keem merged commit 0a41965 into main Jun 17, 2026
10 checks passed
@6-keem 6-keem deleted the docs/sync-architecture-docs branch June 17, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서 개선 또는 추가

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] README 작성 및 stale 아키텍처 문서 정정

1 participant