Skip to content

Document Machines: docs page, guide, README, landing page and changelog - #70

Merged
marcellosso merged 5 commits into
feat/machinesfrom
docs/machines
Nov 5, 2026
Merged

marcellosso merged 5 commits into
feat/machinesfrom
docs/machines

Conversation

@marcellosso

Copy link
Copy Markdown
Owner

Closes #69. Docs and website for Machines (#66, #67).

Base is feat/machines: #67 wasn't merged yet when I finished. Once it is, rebase onto main and retarget this PR.

Summary

 README.md
+  feature bullet, "8. Run Projects on another computer", FAQ "dev box or home server", machines.json under Data
~  "7. Move a Project to another machine" → "7. Copy a Project's configuration to another computer"
 site/src/content/
+  docs/machines.md             what stays on it, requirements (BatchMode, host key, PATH / ~/.zshenv),
+                               any network, Forwards, sidebar, reconnecting/sleep/quitting, every MachineProblem
+  guides/remote-dev-box.md     ssh -L + tmux today, Tailscale + ~/.ssh/config, then localhost
+  changelog/0.5.0.md           released: false, like 0.4.0 before its release
~  docs/introduction.md, docs/data.md   feature bullet, Machine and Forward in the words table, machines.json
 site/src/lib/
~  docs.ts    Machines under "Using localhost", after Ports
~  guides.ts  the new guide and its FAQ
~  faq.ts     the dev box question (homepage, JSON-LD, llms.txt)
 site/src/pages/index.astro
+  #machines section: copy + a sidebar mock (this computer's Projects, a devbox section, a Forward line)
~  directory: + Machines, + Questions (#faq), 4 columns (2 under 1100px), so the grid stays full
~  featureList: + Machines

The text comes from the code: messages from MachineProblem::message, retry delays from RETRY_DELAYS (1, 2, 5, 15, 30 s), wake on macOS only (NSWorkspace.didWakeNotification; the desktop app has no wake hook), ssh options from ssh.rs, the 45 s silence from relay::SILENCE_TIMEOUT. The troubleshooting table leaves out TooOld(Some(version)), since nothing constructs it, so users only see the variant without a version. The page says Machine Projects are edited on that Machine (#68). llms.txt is generated from docs.ts, guides.ts and faq.ts, so it picks the new pages up with no change of its own. No new folders, so ignore-build.sh and the CI changes job stay as they are.

Evidence

  • Before: /docs/machines and /guides/remote-dev-box don't exist; nothing user-facing mentions Machines.
    After: pnpm build in site/: 36 pages, no warnings. Every new in-page link resolves to a generated id (#what-it-needs, #when-it-cant-connect, /docs/mcp#use-it-in-a-terminal, /docs/install#homebrew-macos, /docs/ports#the-ports-view). llms.txt lists the doc, the guide and the FAQ, and /changelog shows the 0.5.0 entry as Unreleased.
  • I haven't looked at the landing page section or the 4-column directory in a browser, only built them.

Screenshots for Marcel to add (Mac): Settings › Machines with a connected Machine, and the sidebar with a Machine section (ideally one connected and one waiting for Reconnect), each in light and dark. They'd fit in docs/machines.md under "Add a Machine" and "In the sidebar", and in README step 8. I left no placeholder images.

For you to check:

  • The version is 0.5.0 (the entry's version and the "Connected · localhost 0.5.0" example). Change both if the release is another one.
  • Windows as the computer doing the viewing: Windows' OpenSSH has no ControlMaster, and SshLink relies on one. I didn't test it, so the docs don't say which platforms work as the viewer. If it doesn't work on Windows, it should be stated there.

Merge Danger

Door: two-way

Docs and site only; no app or core code.

Blast Radius: website

The landing page's directory goes from 3 to 4 columns (2 between 900 and 1100 px), which changes how it lays out on every page load. Everything else is new content.

@vercel

vercel Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
localhost-web Ready Ready Preview Nov 5, 2026 3:22am UTC

@marcellosso
marcellosso merged commit 85de814 into feat/machines Nov 5, 2026
12 checks passed
@marcellosso
marcellosso deleted the docs/machines branch November 5, 2026 03:43
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