Skip to content

README 상단 빠른 적용 안내 추가 #22

@postmelee

Description

@postmelee

배경

현재 README에는 "새 저장소에 빠르게 적용하기" 섹션과 npx hyper-waterfall 예시가 있지만, 첫 화면 상단에서는 사용자가 바로 무엇을 실행하거나 AI에게 무엇을 요청해야 하는지 빠르게 파악하기 어렵다.

v0.2.0 배포 준비와 함께 README 상단에 짧은 빠른 적용 안내를 두면, 사용자가 긴 설명을 읽기 전에 Hyper-Waterfall 적용 경로를 이해할 수 있다. 다만 npm publish와 GitHub Release/tag가 아직 준비 중인 상태라면 install처럼 확정 배포를 암시하는 문구는 피하고, canonical 기준과 승인 게이트를 해치지 않는 범위로 안내해야 한다.

목표

  • README 첫 화면 근처에 3~5줄 수준의 빠른 적용 안내를 추가한다.
  • AI에게 보낼 적용 프롬프트와 docs/agent-entrypoint.md 기준을 짧게 연결한다.
  • npm CLI 예시는 publish 상태와 충돌하지 않도록 dry-run 또는 보조 채널로 표현한다.
  • 추가 안내가 기존 "새 저장소에 빠르게 적용하기" 섹션과 중복되거나 과도하게 길어지지 않게 한다.

범위 - 포함

  • README 상단 또는 첫 viewport 근처의 빠른 적용 안내 문구 설계
  • 기존 "새 저장소에 빠르게 적용하기" 섹션과 중복 점검
  • docs/agent-entrypoint.md, GitHub Release/tag, manifest, migration guide, npm CLI 경계와의 정합성 점검
  • 문서 grep 및 git diff --check 검증

범위 - 제외

  • npm publish 실행
  • GitHub Release/tag 생성
  • Homebrew, Docker, plugin 구현
  • CLI 동작 변경
  • 매뉴얼 또는 SKILL 본문 변경

수용 기준

  • README 첫 화면 근처에서 사용자가 Hyper-Waterfall 적용 시작 방법을 빠르게 확인할 수 있다.
  • 안내 문구가 실제 배포 상태보다 앞서 install 완료를 암시하지 않는다.
  • docs/agent-entrypoint.md가 적용 절차 기준이라는 점이 유지된다.
  • 기존 "새 저장소에 빠르게 적용하기" 섹션과 역할이 중복되지 않는다.
  • canonical 기준인 GitHub Release/tag, templates/manifest.json, migration guide를 흐리지 않는다.

검증 기준

  • rg -n '빠르게 적용|agent-entrypoint|npx hyper-waterfall|GitHub Release|manifest|migration' README.md
  • git diff --check
  • README diff 수동 확인

참고

마일스톤과 label 후보

  • milestone: M020
    • v0.2.0 배포 전 사용자 진입 문구를 정리하는 마무리 작업이므로 M020이 적합하다.
  • labels: documentation, infrastructure
    • documentation: README 문서 개선
    • infrastructure: 배포·설치 진입 운영 구조

확인

  • 기존 열린 이슈와 중복되지 않음을 확인했습니다.
  • 이번 task에서 제외할 항목을 명시했습니다.
  • 작업 시작 전 수행계획서 승인 절차가 필요함을 이해했습니다.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationinfrastructure저장소 인프라, 자기 적용, 운영 구조

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions