Skip to content

docs: add onboarding docs and setup scripts (fix missing files from #6) - #8

Closed
redsunjin with Copilot wants to merge 2 commits into
mainfrom
copilot/docsadd-onboarding-docs-again
Closed

docs: add onboarding docs and setup scripts (fix missing files from #6)#8
redsunjin with Copilot wants to merge 2 commits into
mainfrom
copilot/docsadd-onboarding-docs-again

Conversation

Copilot AI commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

PR #6 merged without including the intended onboarding documentation and setup scripts. This PR adds those missing files.

New files

  • docs/PLAN.md — Archives the original README (planning/architecture) content verbatim under a descriptive header
  • README.md — Replaces the planning doc with a public-facing Korean README: concept, purpose, quick start, and pointers to USER_GUIDE.md / docs/PLAN.md
  • USER_GUIDE.md — Step-by-step Korean guide: install, .env setup, agent integration (curl / hooks / VS Code), approve/undo flow, security tips
  • .env.example — Canonical placeholder for MAIN_REPO_PATH, PORT, VITE_WS_URL, MAESTRO_SERVER_TOKEN

Setup scripts

  • scripts/setup_env.sh — Copies .env.example.env with overwrite prompt (Linux/macOS)
  • scripts/setup_env.ps1 — Same, for Windows PowerShell
  • scripts/configure.js — Interactive Node.js configurator using prompts; walks through each env var and writes .env

package.json changes (additive only)

"scripts": {
  "configure": "node scripts/configure.js"   // new
},
"devDependencies": {
  "prompts": "^2.4.2"                         // new
}

.gitignore already excludes .env — no change needed.

Original prompt

Create a corrective PR on redsunjin/maestro-coding to add the missing onboarding documentation and setup scripts that were intended in PR #6 but did not appear in the repository. Create a new branch named docs/add-onboarding-docs off main and add/modify the following files. Preserve existing repo content when merging package.json changes.

Goals

  • Ensure the original README content (the earliest README content that describes planning/architecture) is preserved by copying it into docs/PLAN.md.
  • Add a new public README.md (Korean) with concept, purpose, quick start, and pointers to USER_GUIDE.md and docs/PLAN.md.
  • Add USER_GUIDE.md (Korean) with installation, .env usage, agent integration examples, approve/undo guidance, and security tips.
  • Add .env.example with placeholder env variables.
  • Add setup scripts: scripts/setup_env.sh, scripts/setup_env.ps1, scripts/configure.js (Node interactive using prompts).
  • Update package.json (merge scripts and devDependencies if package.json exists; otherwise create minimal package.json). Do not remove existing fields.
  • Ensure .gitignore contains .env (add if missing).
  • Commit, push the branch, and open a PR titled: "docs: add onboarding docs and setup scripts (fix missing files from [WIP] Add documentation and setup scripts for onboarding improvement #6)". In the PR description explain that PR [WIP] Add documentation and setup scripts for onboarding improvement #6 merged but did not include the files; this PR adds them.

Files to add/modify (exact contents):

  1. docs/PLAN.md
# 기획 / 아키텍처 문서 보관소 (PLAN)

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

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

Note: When creating docs/PLAN.md, locate the earliest or pre-modification version of README.md in Git history (the original project README) and copy its full contents into docs/PLAN.md so the planning doc is preserved.

  1. README.md (new public README)
# 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를 참고하세요.

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

## 기여 방법(Contributing)
- 이 레포는 오픈 실험용입니다. 기여하려면 이슈를 남기고 PR을 보내주세요.
- 민감 정보(토큰 등)는 절대 커밋하지 마세요. `.env`를 사용하세요.
  1. USER_GUIDE.md
# 사용자 가이드 (User Guide)

이 문서는 로컬에서 Maestro를 설치하고, 에이전트(예: VS Code, 훅 스크립트)와 연동해 승인 플로우를 테스트하는 방법을 단계별로 안내합니다.

목차
- 요구사항(Prerequisites)
- 빠른 설치(Quick install & run)
- 환경변수(.env) 설정 방법
- 에이전트 연동 예제 (curl / 훅 / VS Code)
- 승인(Approve) 시나리오 테스트
- 롤백(UNDO) 사용법
- 보안 권장사항

---

## 요구사항
- Node.js (v16+ 권장)
- Git (로컬에 병합 가능한 레포가 있어야 함)

## 빠른 설치 & 실행
1. 소스 클론
   git clone https://github.com/redsunjin/maestro-coding.git
   cd maestro-coding

2. (선택) 의존성 설치
   npm install

3. .env 준비
   - 루트에 `.env` 파일을 생성하거나 환경변수로 설정.
   - 최소값:
     - MAIN_REPO_PATH: 병합을 수행할 메인 레포지토리의 로컬 경로
     - PORT (선택, 기본 8080)
     - MAESTRO_SERVER_TOKEN (선택, 인증을 사용할 경우)
   예시 `.env`:
   ```
   MAIN_REPO_PATH=/home/user/projects/my-main-repo
   PORT=8080
   MAESTRO_SERVER_TOKEN=very-secret-token
   ```

4. 서버 실행
   - 환경변수 방식:
     MAIN_REPO_PATH=/path/to/main/repo node maestro-server.js
   - 또는 dotenv 사용:
     node -r dotenv/config maestro-server.js

## 에이전트 연동 예제
1) curl로 승인 요청 보내기
```
curl -X POST http://localhost:8080/api/request \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN_IF_USED>' \
  -d '{
    "agentId":"local_agent",
    "branchName":"feature/test-branch",
    "diffSummary": { "title":"작업 완료", "shortDescription":"파일 A 수정" }
  }'
```

2) Git 훅(예: notify-maestro.sh)
- 레포 내 hooks/notify-maestro.sh를 사용하면 커밋/훅에서 자동으로 Maestro에 요청을 보낼 수 있습니다.
- 사용 전에 `MAESTRO_URL` 환경변수를 설정하세요:
  export MAESTRO_URL=http://localhost:8080
  ./hooks/notify-maestro.sh feature/my-branch "제목" "간단한 변경 요약"

3) VS Code 연동
- 간단한 방법: `.vscode/settings.json``maestro.url` 설정을 추가하거나, 작업(Task)으로 curl 명령을 만들어 실행.

## 승인(Approve) 테스트 방법
1. 에이전트가 `POST /api/request` 호출 → 서버는 WebSocket으로 AGENT_TASK_READY 이벤트를 보냅니다.
2. 대시보드(또는 WebSocket 클라이언트)에서 아래 메시지를 서버로 전송하여 승인 시뮬레...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).

Co-authored-by: redsunjin <17919877+redsunjin@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing onboarding documentation and setup scripts docs: add onboarding docs and setup scripts (fix missing files from #6) Feb 27, 2026
@redsunjin redsunjin closed this Feb 27, 2026
@redsunjin
redsunjin deleted the copilot/docsadd-onboarding-docs-again branch February 27, 2026 13:44
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.

2 participants