Skip to content

docs: document deploy.js - #47

Merged
WesleyHanauer merged 1 commit into
WesleyHanauer:developmentfrom
chrisriv10:docs/document-deploy-js
Sep 4, 2026
Merged

WesleyHanauer merged 1 commit into
WesleyHanauer:developmentfrom
chrisriv10:docs/document-deploy-js

Conversation

@chrisriv10

Copy link
Copy Markdown
Contributor

Closes #37

What: Added plain explanatory comments to src/commands/deploy.js in the house style (matching add.js/setup.js, no JSDoc tags):

  • top-of-file block explaining Vite build + Wrangler deploy of dist/ to Cloudflare Pages, run from user project dir via process.cwd()
  • note above try/catch on loading generated globalVariables.js and why ERR_MODULE_NOT_FOUND gets a friendly setup hint
  • one-liner above npxCommand on the Windows .cmd quirk
  • two-stage notes above each execSync (Vite build, then Wrangler deploy)

Why: deploy.js had zero comments; this documents intent for newcomers per issue #37.

Testing: comments-only, no behavior change. Verified git diff shows 14 insertions, 0 deletions (comments/blank lines only) and node --check src/commands/deploy.js passes.

Copilot AI lite review requested due to automatic review settings September 4, 2026 22:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@WesleyHanauer WesleyHanauer left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thanks.

@WesleyHanauer
WesleyHanauer merged commit d8ff6b3 into WesleyHanauer:development Sep 4, 2026
1 check passed
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.

3 participants