[WIP] Add documentation and setup scripts for onboarding improvement

[Copilot]

• Explore repository structure and existing files
• Create docs/PLAN.md with original README content
• Replace README.md with new public-facing README
• Create USER_GUIDE.md with full installation/usage guide
• Create .env.example with placeholder env vars
• Create scripts/setup_env.sh (bash setup script)
• Create scripts/setup_env.ps1 (PowerShell setup script)
• Create scripts/configure.js (Node interactive setup)
• Update package.json (add setup/start scripts, prompts/dotenv devDependencies)

Original prompt

Create a documentation and setup PR to improve onboarding and separate the project planning doc from the public README. Changes to make:

Goals

• Move the existing planning / architecture content into docs/PLAN.md (preserve original content from README.md that contains planning/architecture text).
• Create a new user-facing README.md with concise concept, purpose, quick start, and links to USER_GUIDE.md and docs/PLAN.md.
• Add USER_GUIDE.md with step-by-step installation, .env usage, agent integration examples (curl, hooks, VS Code), testing approve/undo, and security guidance.
• Add .env.example for env vars used by the server.
• Add setup scripts for convenience:
  • scripts/setup_env.sh (bash) — copies .env.example to .env, optionally prompts for MAIN_REPO_PATH and MAESTRO_SERVER_TOKEN.
  • scripts/setup_env.ps1 (PowerShell) — Windows equivalent.
  • scripts/configure.js — Node interactive setup script (uses prompts) and executable via npm run setup.
• Add small server code snippet for dotenv and token check guidance (note: do NOT change server behavior beyond optional suggestion). If package.json needs scripts and devDependencies updated, add them.

Files to add/modify (include exact file contents below):

1. docs/PLAN.md

• Move the existing README planning/architecture content here. Preserve original language (Korean) and structure. (Placeholder: include the current README content that describes architecture, API, and examples.)

Content to create (placeholder header and a directive to paste the existing README planning content):

"""

기획 / 아키텍처 문서 보관소 (PLAN)

이 파일은 기존 README.md(기획 문서)를 보관하는 용도로 사용합니다.
프로젝트 초기 기획, 아키텍처, 실험 메모, 설계 결정 사항 등 변경·보존해야 하는 문서를 이곳으로 옮겨주세요.

---

(기존 README.md의 기획/아키텍처 전문을 이 위치에 그대로 옮겨주세요)
"""

2. README.md (new public README)

• Provide the concise public-facing README content (Korean), similar to the template provided in the chat. Include Quick Start and pointer to USER_GUIDE.md and docs/PLAN.md.

Content (full file included in problem statement):

"""

Maestro Coding

코딩을 지휘하다 — AI 에이전트와 함께하는 코드 심포니 🎼

컨셉(Concept)

Maestro는 AI 에이전트가 생성하거나 수정한 코드 변경을 "승인 노트" 형태로 제시하고, 사람이 빠르게 승인/반려하여 안전하게 병합하도록 돕는 개발 보조 도구입니다.

만든 목적(Purpose)

• AI 에이전트 자동 생성 코드를 인간이 빠르게 확인하고 승인할 수 있도록 가시화
• 승인(merge) 워크플로우를 단순화하여 생산성 향상
• 로컬 개발 환경에서 안전하게 에이전트와 협업할 수 있는 도구 제공

주요 기능(At a glance)

• 에이전트가 POST /api/request 로 승인 요청 전송
• Maestro 서버는 WebSocket으로 대시보드에 알림 브로드캐스트
• 사용자가 대시보드에서 APPROVE/REJECT/UNDO 조작 가능
• 승인 시 서버에서 로컬 git 병합(merge)을 수행

빠른 시작(Quick Start)

1. 레포지토리 클론
   git clone https://github.com/redsunjin/maestro-coding.git
2. 의존성 설치 (필요한 경우)
   npm install
3. 설정 파일(.env) 준비
   • 루트에 .env 또는 환경변수로 설정.
   • 예: MAIN_REPO_PATH=/path/to/your/main/repo
4. 서버 실행
   MAIN_REPO_PATH=/path/to/your/main/repo node maestro-server.js
5. 에이전트(또는 훅)에서 승인 요청 전송 (예시)
   curl -X POST http://localhost:8080/api/request
   -H 'Content-Type: application/json'
   -d '{"agentId":"local_agent","branchName":"feature/x","diffSummary":{"title":"작업 완료","shortDescription":"변경요약"}}'

설치 가이드(Installation)

자세한 설치/사용법은 USER_GUIDE.md를 참고하세요.

사용자 가이드(User Guide)

자세한 사용자 안내는 USER_GUIDE.md를 확인하세요.

기획 문서 / 아키텍처

기획 및 아키텍처 문서는 docs/PLAN.md로 분리되어 있습니다.

기여 방법(Contributing)

• 이 레포는 오픈 실험용입니다. 기여하려면 이슈를 남기고 PR을 보내주세요.
• 민감 정보(토큰 등)는 절대 커밋하지 마세요. .env를 사용하세요.
  """

3. USER_GUIDE.md

• Full user guide content (as drafted in chat) — install, .env, examples, approve flow, undo, security, debugging tips.

(Include the full content as provided in the chat earlier.)

4. .env.example

• Provide example env variables:

"""

Maestro server 기본 설정

PORT=8080
MAIN_REPO_PATH=/path/to/your/main/repo
MAESTRO_SERVER_TOKEN=replace-with-a-secret-token
"""

5. scripts/setup_env.sh

• The bash setup script content as drafted in the chat (copy .env.example to .env and optionally prompt for MAIN_REPO_PATH and token).

6. scripts/setup_env.ps1

• PowerShell equivalent content.

7. scripts/configure.js

• Node interactive prompts script content. Uses prompts package. Make it executable via node.

8. package.json modifications (if required)

• Add scripts:
  • "setup": "node scripts/configure.js"
  • "start": "node maestro-server.js"
  • "server": "node maestro-server.js"
• Add devDependencies (if package.json exists):
  • "prompts": "^2.0.0"
  • "dotenv": "^16.0.0"

Notes and requirements for the PR

• Move content: ensure docs/PLAN.md contains the original README planning/architecture text. I requested a placeholder; please copy the original README content into docs/PLAN.md when applying the changes.
• Do not commit any real secret values. .env.example should contain placeholders and .env must be in .gitignore.
• If package.json is modified, ensure merges preserve existing fields; update only scripts and devDependencies additions (merge with existing content).

Please create a pull request on redsunjin/maestro-coding with these changes and include a clear PR description: "docs: split planning README into docs/PLAN.md; add publi...

This pull request was created from Copilot chat.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.