Skip to content

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

Description

@6-keem

확인 사항

  • 동일하거나 유사한 작업이 없는지 검색했습니다.

배경 / 목적

오픈소스 공개에 맞춰 문서를 정비한다.

  • README: 현재 배지 + 썸네일만 있고 본문이 비어 있어, 공개 저장소 방문자/기여자에게 프로젝트 소개·기능·설치·기여 안내가 전혀 없다.
  • stale 문서: CLAUDE.md(Architecture)와 .claude/rules/typescript.md가 이미 삭제된 구조를 그대로 서술하고 있다.
    • 진입점 3개 → 실제 2개 (Options Page 삭제됨)
    • Background의 Chrome alarm/notification 스케줄링 → 실제로는 제거됨 (manifest 권한도 storage·identity뿐)
    • Content Script 경로 src/content/index.tsx → 실제 src/popover/index.tsx
    • ShadowRootContext 경로 src/lib/ → 실제 src/popover/lib/

코드에는 dead code가 없으며(빌드/엔트리/권한 모두 정리됨), 문제는 문서만 코드보다 뒤처져 있다는 점이다.

할 일

  • README 본문 작성 (소개 / 주요 기능 / 설치 / 기술 스택 / 문서 / 기여 / 라이선스)
  • CLAUDE.md Architecture 섹션을 실제 진입점 2개 구조로 정정
  • .claude/rules/typescript.md의 경로·메시지 패싱 설명 정정

완료 기준

  • README가 실제 코드와 일치하고 공개 저장소 현관문 역할을 한다.
  • 문서에 삭제된 Options Page / alarm·notification 스케줄링 언급이 남아있지 않다.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs문서 개선 또는 추가

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions