Skip to content

docs(dx): daemon-lifecycle drift + fix docs:lint on main (mache-823d91, mache-89e322)#466

Merged
jamestexas merged 3 commits into
mainfrom
dx/mache-823d91-daemon-lifecycle
Jul 2, 2026
Merged

docs(dx): daemon-lifecycle drift + fix docs:lint on main (mache-823d91, mache-89e322)#466
jamestexas merged 3 commits into
mainfrom
dx/mache-823d91-daemon-lifecycle

Conversation

@jamestexas

Copy link
Copy Markdown
Contributor

DX docs-hygiene pass. Two independent doc defects, both green-gate now.

mache-89e322 — docs:lint red on main

docs/smell-debt-baseline-2026-06-24.md shipped without frontmatter, so task docs:lint failed on main (missing frontmatter). Added minimal valid frontmatter (covers-version: v0.8.0 to match ARCHITECTURE.md / latest CHANGELOG, last-verified = measurement date). docs:lint now reports 0 fail, 0 warn.

mache-823d91 — stale claim on a shipped feature

The keepalive supervisor shipped in v0.10.0 (#464): mache init --global installs a launchd LaunchAgent (macOS) or systemd --user unit (Linux) that starts + keepalives the shared HTTP daemon (cmd/daemon_agent.go, wired at cmd/init.go:62, 5 passing tests). But GETTING-STARTED.md still told users the connection-refused fix was unbuilt and "tracked in mache-823d91". Updated the #1 first-run gotcha to point at the shipped one-command fix.

Not in scope

mache-823d91's second half — daemon-reliability hardening (stale ~/.mache state, singleton-socket clobber; see ADR-0022 + mache-0a1ded) — is untouched here and stays open. This PR only closes the supervisor-doc gap.

Verification

  • task docs:lint → 0 fail, 0 warn
  • go test ./cmd/ -run 'TestLaunchAgent|TestSystemd|TestDaemonAgent' → ok
  • Docs-only; no Go changed.

…s:lint on main

docs:lint requires covers-version + last-verified frontmatter on every
top-level docs/*.md; this dated snapshot shipped without it and reddened
the gate on main. Add minimal valid frontmatter (covers-version v0.8.0 to
match ARCHITECTURE.md / latest CHANGELOG, last-verified = measurement date).
…` supervisor

The keepalive supervisor shipped in v0.10.0 (#464): `mache init --global`
installs a launchd LaunchAgent (macOS) or systemd --user unit (Linux) that
starts + keepalives the shared HTTP daemon. GETTING-STARTED still told users
it was unbuilt and "tracked in mache-823d91". Update the connection-refused
gotcha to point at the shipped one-command fix.

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.

Pull request overview

Updates developer documentation to reflect the current daemon lifecycle/onboarding flow and to restore docs:lint green on main by ensuring required frontmatter exists.

Changes:

  • Update the first-run “connection refused” guidance to point to the shipped mache init --global supervisor-based fix (launchd/systemd user service).
  • Add minimal YAML frontmatter to docs/smell-debt-baseline-2026-06-24.md so task docs:lint passes.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
GETTING-STARTED.md Refreshes onboarding troubleshooting to reference the global supervisor install as the recommended fix for the HTTP daemon lifecycle.
docs/smell-debt-baseline-2026-06-24.md Adds required frontmatter (covers-version, last-verified, etc.) to satisfy docs lint rules.

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

Comment thread GETTING-STARTED.md Outdated
…w nit)

Copilot flagged "keepalives" as jargon/incorrect verb form in user-facing
docs. Use the standard phrasing.
@jamestexas jamestexas enabled auto-merge (squash) July 2, 2026 00:04
@jamestexas jamestexas merged commit c21a22f into main Jul 2, 2026
8 checks passed
@jamestexas jamestexas deleted the dx/mache-823d91-daemon-lifecycle branch July 2, 2026 00:06
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.

2 participants