docs(agents): document the local dev stack and worktree workflow#6015
Merged
Conversation
Contributor
Automated Reviewer SuggestionsBased on the
|
Yicong-Huang
force-pushed
the
docs/agents-local-dev
branch
from
034afe5 to
d25729f
Compare
Yicong-Huang
changed the title
bobbai00
approved these changes
Jun 29, 2026
Add a "Where Things Live" row routing agents to bin/local-dev.sh as the single entry point for the local dev stack (infra in Docker; backend, frontend, and agent-service run natively), and expand the worktree section: - prefer bin/local-dev.sh while developing; - bounce it across worktree switches (down in the old worktree, up in the new one) since the native services bind fixed ports and share one state dir; - use the non-interactive CLI subcommands — the interactive TUI (-i) is for humans, not agents. Also drop "Local" from the single-node / k8s deploy row — both can deploy anywhere, not just locally. Closes apache#6014
Yicong-Huang
force-pushed
the
docs/agents-local-dev
branch
from
d25729f to
ee46fa9
Compare
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
2 participants
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.
What changes were proposed in this PR?
AGENTS.mddocuments the single-node and k8s deploy paths but never tells an agent how to run the local dev stack. This PR:bin/local-dev.sh— the single entry point (infra in Docker; backend, frontend, and agent-service run natively);bin/local-dev.shwhile developing;downin the old worktree,upin the new one), since the native services bind fixed ports and share one PID/state dir, so only one worktree's stack runs at a time;-i) is for humans, not agents.Only the wrapper is surfaced, never the internal
bin/local-dev/main.sh.Any related issues, documentation, discussions?
Closes #6014
How was this PR tested?
Docs-only change; no tests. Verified the linked
bin/local-dev/README.mdpath resolves and that the described subcommands (up/down/status/logs/-i) matchbin/local-dev.sh --help.Was this PR authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Claude Opus 4.8)