Skip to content

Docs: say host, not machine, for the enrolled computer - #2721

Merged
hernan-alvarez merged 2 commits into
masterfrom
claude/docs-machine-vs-host
Oct 18, 2026
Merged

hernan-alvarez merged 2 commits into
masterfrom
claude/docs-machine-vs-host

Conversation

@hernan-alvarez

@hernan-alvarez hernan-alvarez commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

A vocabulary pass on the docs tree, following Positioning Fundamentals v6.6, Section 10. On product surfaces, "host" replaces "machine" for the enrolled computer. The site half is hyparam/hypaware.ai#95. The rename ticket for CLI output and field names is #2720.

What changed

  • Every "machine" that means the enrolled computer now says "host", in prose, headings, code comments, and <!-- agent: --> prompts. "machine-local" became "host-local".
  • The definition line sits at first use on the overview (README.md) and on Connect a host (TEAM_SETUP.md): "A host is any machine the collector runs on: a laptop, a build box, a remote agent's box."
  • Headings: Connect a host, Disconnect a host, Long-lived headless hosts. Links in CLI.md, PRIVACY.md, and TEAM_SETUP.md follow the new anchors. The old #connect-a-machine-style anchors stop resolving.
  • "different from a laptop install" became "different from an interactive install". This is the one place where swapping in "host" would have changed the meaning.
  • The join-token passages (TEAM_SETUP CI section, CLI_REFERENCE hyp remote mint) now say host / host record. hyp remote mint still prints gateway <id>, so each passage gets the line "shown as gateway in the current CLI output; this is the host record". Remove it once Say host, not gateway or machine, in CLI output and user-facing field names #2720 lands.
  • MCP_REFERENCE.md is generated, so the same one-word change went into scripts/gen-mcp-reference.js.

Hit counts (occurrences, case-insensitive)

File machine laptop gateway
CLI.md 6 → 0 0 0
CLIENTS.md 1 → 0 0 5 → 5
CLI_REFERENCE.md 14 → 1 0 19 → 18
CODEX-CLOUD.md 0 0 1 → 1
CONFIGURATION.md 2 → 0 0 1 → 1
MCP.md 1 → 0 0 0
MCP_REFERENCE.md 1 → 0 0 1 → 1
PLUGIN_AUTHORING.md 0 0 3 → 3
PRIVACY.md 21 → 0 0 6 → 6
QUERYING.md 4 → 0 0 8 → 8
README.md 2 → 1 0 → 1 0
TEAM_SETUP.md 16 → 1 1 → 1 4 → 1
TROUBLESHOOTING.md 4 → 1 0 7 → 7

Remaining hits and why they stay:

  • README.md, TEAM_SETUP.md: the definition line ("any machine", "a laptop").
  • CLI_REFERENCE.md:113 "the stable machine form", TROUBLESHOOTING.md:100 "machine-readable": these mean output a program reads, not the enrolled computer.
  • gateway: every remaining hit names the local AI gateway proxy, the ai_gateway_messages dataset, or the @hypaware/ai-gateway plugin, all of which are components and never a host. The two exceptions are the flagged literal lines in TEAM_SETUP.md and CLI_REFERENCE.md.

Notes

  • PRIVACY.md:59 now says "The gateway decrypts AI provider hosts named by the configured capture adapters". "other hosts are tunneled" in the same sentence still uses hosts for network servers.
  • TEAM_SETUP / CLI_REFERENCE: many CI runners that join with one token share one host record, which doesn't line up with "a host is any machine the collector runs on". I used "host record" where the shared row matters.

Checks

  • node --test on the docs-touching suites (cli-consistency-gate, docs-agent-markers, docs-mcp-configs, mcp-reference-drift, team-setup-disclosure, report-commands, daemon-backfill-sweep, daemon-heap-budget-knob): 238 pass.
  • Built the site docs from this branch with npm run docs:build. The new anchors resolve and nothing links to a #...machine anchor. The Pagefind step was skipped locally because pagefind isn't installed.
  • No em dashes in any touched file.

🤖 Generated with Claude Code

Hernan Alvarez and others added 2 commits October 17, 2026 20:04
Vocabulary pass per Positioning Fundamentals v6.6, Section 10. Defines host
once on the overview and on Connect a host; headings and anchors follow
(connect-a-host, disconnect-a-host, long-lived-headless-hosts). Where the
mint output still prints gateway, the docs keep the literal and flag it
(#2720).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hernan-alvarez
hernan-alvarez added this pull request to the merge queue Oct 18, 2026
Merged via the queue into master with commit eadd920 Oct 18, 2026
8 checks passed
@hernan-alvarez
hernan-alvarez deleted the claude/docs-machine-vs-host branch October 18, 2026 04:15
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.

1 participant