Skip to content

docs: README를 설치와 사용 흐름 중심으로 개선 - #9

Merged
jeonsworld merged 1 commit into
mainfrom
docs/readme-onboarding
Sep 16, 2026
Merged

jeonsworld merged 1 commit into
mainfrom
docs/readme-onboarding

Conversation

@jeonsworld

Copy link
Copy Markdown
Contributor

README에 설치 안내와 인증 예외, 개발·릴리스 절차가 섞여 있어 시작 방법을 찾기 어려웠습니다. 설치 → 첫 요청 → 사용 예시 → 업데이트 → 문제 해결 순서로 재구성하고, 환경별 설치와 상세 명령은 접어서 필요한 내용만 펼쳐 읽도록 정리했습니다.

  • README 분량 약 32% 축소, 복사 가능한 첫 요청과 업무별 예시 제공
  • 출시된 1.1.1의 에이전트 바로가기 링크 안내 유지, 저장소 접근 안내를 현재 Internal 설정에 맞게 수정
  • 저장소 구조·검증·릴리스 상세는 CONTRIBUTING.md로 이동
  • 안내 문서 두 개만 변경하며 Plugin version은 1.1.1 유지

검증: 설치된 Codex·Claude CLI 도움말에서 명령 확인, GitHub Markdown 렌더링의 표·접기 영역 확인, 내부 링크·목차 대상·이미지 경로 검사, 패키지 validator 및 git diff --check 통과.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Warning

Review limit reached

  • Run on-demand review

On-demand reviews are free for the next 24 days. After that, they cost $0.25 per reviewed file.

Or wait 26 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available. Your 39 included PR review attempts over the past 7 days set your current allowance at 4 reviews per hour.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 46460b3e-0d77-4d77-8d6d-134b8a39465b

📥 Commits

Reviewing files that changed from the base of the PR and between c3e84b1 and 079320c.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

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

@jeonsworld jeonsworld self-assigned this Sep 16, 2026
@jeonsworld
jeonsworld merged commit c6f1c1d into main Sep 16, 2026
3 checks passed
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