Skip to content

docs: improve setup guide with first-time build fixes and Tailscale section#65

Open
donovan-yohan wants to merge 2 commits into
GoogleCloudPlatform:mainfrom
donovan-yohan:docs/setup-improvements
Open

docs: improve setup guide with first-time build fixes and Tailscale section#65
donovan-yohan wants to merge 2 commits into
GoogleCloudPlatform:mainfrom
donovan-yohan:docs/setup-improvements

Conversation

@donovan-yohan
Copy link
Copy Markdown

Summary

Closes #63

  • Clarify make build vs make all — note that make build omits web assets (web UI will 404)
  • Add "Build Container Images" section with GitHub Actions and local build instructions, including --target all for first builds and arm64 performance warning
  • Add scion config set --global image_registry to init instructions
  • Add "Workstation Server with Tailscale" section showing tailscale serve pattern
  • Default GitHub Actions build target to all and reorder choices
  • Improve Makefile target descriptions

Test plan

  • Verify README renders correctly on GitHub
  • Confirm make all and make build descriptions match actual behavior
  • Validate the local container build commands work on a fresh fork

🤖 Generated with Claude Code

…ection

README: add build images section with local arm64 build instructions,
clarify make build vs make all, add workstation server + Tailscale guide.
Makefile: clarify that build target excludes web assets.
build-images.yml: default to "all" target since "common" fails on first build.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@google-cla
Copy link
Copy Markdown

google-cla Bot commented Apr 8, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@ptone
Copy link
Copy Markdown
Member

ptone commented Apr 9, 2026

sorry - we need the CLA before we can merge

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.

Improve setup guide for first-time builders and add Tailscale section

2 participants