Skip to content

Add local dev workspace script and localhost binding#990

Merged
tony-xlh merged 2 commits intopreviewfrom
codex/local-dev-workflow-localhost
Apr 10, 2026
Merged

Add local dev workspace script and localhost binding#990
tony-xlh merged 2 commits intopreviewfrom
codex/local-dev-workflow-localhost

Conversation

@lyzhang0113
Copy link
Copy Markdown
Collaborator

This pull request introduces a new PowerShell-based local development workflow for the project, replacing the previous manual and Bash-based instructions. The new workflow simplifies setup, automates environment preparation, and provides flexible options for serving and previewing the documentation site. The README.md has been updated with clear instructions for using the new script, and a comprehensive scripts/dev.ps1 script has been added to handle all setup tasks.

Local development workflow improvements:

  • Added a new PowerShell script scripts/dev.ps1 that automates cloning/updating the template repo, merging docs, installing dependencies, and serving the site, with support for various flags (e.g., -NoServe, -NoTemplateUpdate, -Port, -BindHost).
  • Updated README.md to document the new PowerShell-based workflow, replacing the previous Bash/manual steps, and describing available script flags and local workspace structure.

Environment and reproducibility enhancements:

  • The script ensures all local-only files and build artifacts are kept in a dedicated .dev/ directory, improving workspace cleanliness and reproducibility. [1] [2]
  • Bundler and Jekyll are configured to use isolated local paths within .dev/, reducing the risk of polluting the global environment.

Quality-of-life improvements:

  • The script provides clear step-by-step logging, robust error handling, and checks for required commands (git, robocopy, bundle) before proceeding.
  • Local preview URL and usage examples are now clearly documented in the README.md.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a PowerShell-based local development workflow for building and serving the Jekyll documentation site using a merged workspace (docs repo + template repo), with artifacts isolated under .dev/.

Changes:

  • Added scripts/dev.ps1 to automate template cloning/updating, workspace merging, bundler setup, and jekyll serve (with flags like -NoServe, -NoTemplateUpdate, -Port, -BindHost).
  • Updated README.md to document the new PowerShell workflow, flags, and local preview URL.
  • Updated .gitignore to ignore the new .dev/ workspace and common local Jekyll/Bundler caches.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File Description
scripts/dev.ps1 Implements the automated local workspace + serve workflow and isolates Bundler/Jekyll paths under .dev/.
README.md Replaces prior local dev steps with PowerShell script usage and workspace/flag documentation.
.gitignore Ignores .dev/ and common local build/cache directories to keep the repo clean.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@lyzhang0113 lyzhang0113 marked this pull request as ready for review April 9, 2026 18:09
@lyzhang0113 lyzhang0113 requested a review from Copilot April 9, 2026 18:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@lyzhang0113 lyzhang0113 force-pushed the codex/local-dev-workflow-localhost branch from cbf2d00 to 78393db Compare April 10, 2026 02:26
@tony-xlh tony-xlh merged commit 0338844 into preview Apr 10, 2026
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