docs: add onboarding docs and setup scripts (fix missing files from #6) - #7
Merged
Conversation
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
marked this pull request as ready for review
February 27, 2026 13:20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Files intended to land in PR #6 never appeared in the repo. This PR adds them.
Documentation
README.md— Replaced the raw planning doc with a concise Korean README: concept, purpose, key features, quick start, and pointers toUSER_GUIDE.md/docs/PLAN.mddocs/PLAN.md— Preserves the original README planning/architecture content under a dedicated archive headerUSER_GUIDE.md— Step-by-step Korean guide covering install,.envsetup, agent integration (curl / Claude Code hook / shell / git hook), approve/reject flow, UNDO rollback, and security recommendationsSetup Scripts
scripts/setup_env.sh— Interactive Bash prompt → writes.envscripts/setup_env.ps1— Same for Windows PowerShellscripts/configure.js— Node.js interactive setup viapromptswith port validation; safely skips or overwrites existing.envpackage.jsonAdded two script entries and
promptsdevDependency (no other changes):Environment
.env.example— Placeholder forMAIN_REPO_PATH,PORT,MAESTRO_SERVER_TOKEN,VITE_WS_URL.gitignorealready excludes.env— no change neededOriginal prompt
Create a corrective PR that adds the missing onboarding documentation and setup scripts that were intended in PR #6 but did not appear in the repository. The PR should add the following files to the repository
redsunjin/maestro-codingon a new branch (name: docs/add-onboarding-docs).Goals
.env(do not commit real secrets).Files and contents to add (exact content to be created):
MAIN_REPO_PATH=/home/user/projects/my-main-repo
PORT=8080
MAESTRO_SERVER_TOKEN=very-secret-token
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 수정" }
}'
{"action":"APPROVE","requestId":"req_...","branchName":"feature/test-branch"}