Closed
docs: add onboarding docs and setup scripts (fix missing files from #6)#8
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
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.
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 headerREADME.md— Replaces the planning doc with a public-facing Korean README: concept, purpose, quick start, and pointers toUSER_GUIDE.md/docs/PLAN.mdUSER_GUIDE.md— Step-by-step Korean guide: install,.envsetup, agent integration (curl / hooks / VS Code), approve/undo flow, security tips.env.example— Canonical placeholder forMAIN_REPO_PATH,PORT,VITE_WS_URL,MAESTRO_SERVER_TOKENSetup scripts
scripts/setup_env.sh— Copies.env.example→.envwith overwrite prompt (Linux/macOS)scripts/setup_env.ps1— Same, for Windows PowerShellscripts/configure.js— Interactive Node.js configurator usingprompts; walks through each env var and writes.envpackage.jsonchanges (additive only).gitignorealready 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-docsoffmainand add/modify the following files. Preserve existing repo content when merging package.json changes.Goals
docs/PLAN.md.README.md(Korean) with concept, purpose, quick start, and pointers toUSER_GUIDE.mdanddocs/PLAN.md.USER_GUIDE.md(Korean) with installation, .env usage, agent integration examples, approve/undo guidance, and security tips..env.examplewith placeholder env variables.scripts/setup_env.sh,scripts/setup_env.ps1,scripts/configure.js(Node interactive usingprompts).package.json(merge scripts and devDependencies if package.json exists; otherwise create minimal package.json). Do not remove existing fields..gitignorecontains.env(add if missing).Files to add/modify (exact contents):
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.