Skip to content

docs: add a remote and headless residency guide (#479) - #488

Merged
lidge-jun merged 1 commit into
devfrom
codex/479-remote-docs
Aug 26, 2026
Merged

docs: add a remote and headless residency guide (#479)#488
lidge-jun merged 1 commit into
devfrom
codex/479-remote-docs

Conversation

@parkjs101

Copy link
Copy Markdown
Collaborator

What

structure/remote-headless.md — the guide #479 actually asked for. The three layers below make the failure detectable and give systemd-less hosts a supervisor, but nobody reads a doctor row they never ran.

Contents

  • Why it looks like anything but PATHnohup dies before jaw runs, so the log says No such file or directory and never mentions PATH.
  • Which startup file each shell actually reads in a non-interactive session, as a table.
  • One-line reproduction: env -i PATH="$(getconf PATH)" sh -c 'command -v jaw'.
  • Three fixes in order of preference (absolute path → PATH in the remote command → ~/.zshenv), with the note that bash has no .zshenv equivalent since BASH_ENV is unset by default.
  • Residency: systemd path, the supervisor backend, and what each token of the manual setsid/nohup command buys.
  • Why pidfile presence is not liveness — start-time verification, and the dist/ reload caveat already in AGENTS.md.

One issue suggestion deliberately not adopted

The /usr/local/bin symlink is documented as not recommended: it needs sudo, breaks when the npm prefix moves, and points at the wrong binary under multiple Node versions. ~/.zshenv and absolute paths have none of those failure modes.

Verification

bash structure/check-doc-drift.sh passes (4/4). str_func.md counts refreshed for the new modules per AGENTS.md; linked from structure/INDEX.md and README.

Pre-existing count drift unrelated to this work (src/manager was already 98 vs a documented 94) was left alone apart from the delta my own files introduce.

Refs #479

Stack (merge bottom-up):

# PR Layer Review focus
4 #488 docs — remote/headless guide ← you are here docs only
3 #487 supervisor backend generated sh + liveness contract
2 #486 service guidance operator message correctness
1 #485 doctor detection detection logic + probe seam

Review this PR's diff only; its base is the layer below.

@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The issue asked for one, and the three commits below it are only half an
answer without it: they make the failure detectable and give systemd-less
hosts a supervisor, but nobody reads a doctor row they never ran.

Covers why the failure looks like anything but PATH (nohup dies before jaw
runs, so the log says "No such file or directory" and never says PATH), which
startup file each shell actually reads in a non-interactive session, the
one-line reproduction via `env -i PATH="$(getconf PATH)"`, and the three fixes
in order of preference. It records why the /usr/local/bin symlink suggested in
the issue is not recommended: sudo, breakage when the npm prefix moves, and
wrong-binary risk under multiple Node versions.

The residency half documents the supervisor backend, why liveness is asked of
`service status` rather than pgrep (PID recycling is the same false-healthy
reading #479 hit), and what each token of the manual setsid/nohup command buys.

str_func.md counts refreshed for the new modules per AGENTS.md; doc-drift gate
passes.

Refs #479
@parkjs101
parkjs101 force-pushed the codex/479-supervisor-backend branch from 5208725 to a1c97e8 Compare August 26, 2026 10:53
@parkjs101
parkjs101 force-pushed the codex/479-remote-docs branch from ed7ac47 to 65bd6eb Compare August 26, 2026 10:53
Base automatically changed from codex/479-supervisor-backend to dev August 26, 2026 15:05
@lidge-jun
lidge-jun merged commit cac9a88 into dev Aug 26, 2026
5 checks passed
@lidge-jun
lidge-jun deleted the codex/479-remote-docs branch August 26, 2026 15:05
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