Skip to content

docs: sync skills, README, install guide with mjs-only config#69

Open
reopt-eric wants to merge 2 commits into
mainfrom
docs/sync-mjs-everywhere
Open

docs: sync skills, README, install guide with mjs-only config#69
reopt-eric wants to merge 2 commits into
mainfrom
docs/sync-mjs-everywhere

Conversation

@reopt-eric

Copy link
Copy Markdown
Contributor

Summary

PR #65로 `worktreeConfig`가 `dev-proxy.config.mjs`로 통합된 이후 모든 사용자 문서·스킬을 새 모델에 맞춰 정정 + 신규 사용자가 막히는 알려진 지점(DNS timing, worktree 제약) 보강.

Why

리뷰에서 발견된 두 종류 부채:

  1. PR feat(config): support worktreeConfig in dev-proxy.config.mjs #65 이전 모델(`.dev-proxy.json`에 worktreeConfig)을 가르치는 스킬·문서 — 신규 사용자에게 4개 파일 인지 부담
  2. 신규 사용자 1순위 실패(DNS resolver 적용 지연), worktree 미지원 경고 약함, 한/영 README 일부 갭

Changes

Skills (2)

  • `dev-proxy-init/SKILL.md`: Phase 3.2/3.3 통합, `.dev-proxy.json`은 legacy fallback only로 강등, mjs에 worktreeConfig 추가하는 템플릿, frontmatter `verified-against` 메타로 버전 하드코딩 제거
  • `dev-proxy-review/SKILL.md`: 신규 Phase "semantic-release 구성 검증" (releaserc + release.yml + npm pack whitelist), BREAKING CHANGE 감지, GitHub Packages 미러 publish 검증, 버전 하드코딩 제거

Install guide

  • `docs/guide/installation.md`: macOS DNS resolver 적용 후 5–10초 대기 + `dscacheutil -flushcache` 안내, sudo 명령별 1줄 주석, worktree 미지원 경고 박스 강조, 모든 worktreeConfig 예제 mjs로

README

  • `README.md` / `README_KO.md`: 설정 파일 4개 → 3개, worktreeConfig를 mjs 예제에 통합, 포트 변경 주석 정리 + 한/영 동기화, legacy fallback 한 줄

CLAUDE.md

  • Config 단락이 legacy fallback이 `routes`와 `worktreeConfig` 양쪽을 다룬다는 점 명시

chore

  • `pnpm-workspace.yaml`: pnpm 11이 차단하는 esbuild postinstall을 `allowBuilds`로 승인 (별도 커밋)

Test plan

  • `pnpm check` 통과 (typecheck + lint + format + 446 tests)
  • 두 스킬을 신규 사용자가 따라가서 막힘 없는지 (수동)
  • installation.md 따라 빈 macOS 환경에서 처음부터 끝까지 도달 가능 (수동)

Closes #68

🤖 Generated with Claude Code

reopt-eric and others added 2 commits May 23, 2026 17:56
pnpm 11 blocks build scripts by default. esbuild's postinstall is
trusted; approve it in pnpm-workspace.yaml so local developers don't
hit ERR_PNPM_IGNORED_BUILDS on every install.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Reflect the worktreeConfig migration (PR #65) across user-facing docs
and fill onboarding gaps.

- dev-proxy-init/SKILL.md: collapse Phase 3.2/3.3 into one mjs file,
  drop "routes only" warning, frontmatter verified-against meta, mjs
  worktreeConfig template
- dev-proxy-review/SKILL.md: add semantic-release config check
  (releaserc + workflow), npm pack whitelist verification, BREAKING
  CHANGE detection, GitHub Packages mirror verification, drop hard-coded
  version
- installation.md: macOS DNS resolver timing tip (5-10s + dscacheutil),
  per-line sudo annotations, worktree-not-in-wizard warning, all
  worktreeConfig examples now mjs, migration flow updated
- README.md / README_KO.md: config file count 4 -> 3, worktreeConfig
  moved into mjs example, port-change comment de-stuttered, legacy
  fallback note
- CLAUDE.md: Config paragraph clarifies legacy fallback covers both
  routes and worktreeConfig

Closes #68

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented May 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

Sync SKILL/README/install guide after worktreeConfig migration + onboarding gaps

1 participant