Skip to content

docs: restructure the user guide around tasks, and bring it up to 1.6.0 - #90

Merged
teo-goulois merged 1 commit into
mainfrom
docs/user-guide
Nov 9, 2026
Merged

teo-goulois merged 1 commit into
mainfrom
docs/user-guide

Conversation

@teo-goulois

Copy link
Copy Markdown
Contributor

Restructures docs/README.md, the user guide, so people can find how to do something, and brings it up to 1.6.0. One of three docs PRs; they touch different files and can merge in any order.

Structure

The guide now starts with a table of contents, followed by task sections: quick start, running apps, projects and worktrees, domains and routes, coding agents, Localify Cloud (public URLs, apps that check origin, plan and billing, remote machines), access from other devices, and Docker. After those come a reference (commands, configuration, files, the daemon, logging, proxy headers, completions) and troubleshooting.

These anchors are kept, because the desktop app's onboarding, the CHANGELOG and the bug template link to them: #quick-start, #coding-agents, #services-in-the-app-from-the-command-line, #cleaning-up-worktrees, #public-urls, #apps-that-check-origin, #troubleshooting. The same goes for #configuration and #logging-and-verbosity. launch-profiles.md and public-urls.md still link to #apps-that-check-origin.

New, for what shipped up to 1.6.0

  • What localify dev does on first run: creates the project, picks ports, sets up domains and the Next.js/Vite config, and sets the variables it injects. Also covers what happens when the service already runs (asks, or --replace) and its exit codes.
  • Service tabs (1.4): exit code, Restart, Open a terminal here, and Reload shell environment.
  • Launch profiles: a short section, linking to launch-profiles.md.
  • Projects: a table of the commands that repair or extend a project instead of re-running init-project.
  • Worktrees: domain naming, --env, copy-env.
  • Plan and billing: subscribe, --yearly, --machines, --url-packs, billing, and suspended URLs.
  • Remote machines (1.5, 1.6):
    • pairing from the app or with localify machines pair, and the three settings;
    • viewing output, and remote Start/Stop/Restart;
    • asking for access, and "Relaunch to share".
  • Commands reference: the full command table, grouped and checked against the 1.6.0 --help.
  • Headers: X-Forwarded-Port, which the proxy sends, is now listed.

Removed, and why

  • "Certificates show wrong domain name … run localify restart after registering": stale. Since 1.1.0 a domain works when register returns, and unknown .localify names get on-demand certificates.
  • Duplicates:
    • The full Linux file tree is now one sentence: same layout under ~/.config/localify/.
    • Two separate wildcard config examples are merged into one.
    • The daemon's foreground/background and auto-start sections are merged into "The daemon".
  • The Docker section is cut to how to enable it, with a link to docker.md.

Nothing claims the remote --machine CLI flags or MCP machine arguments described in remote-machines.md: they aren't in 1.6.0.

docs/linux.md: "main documentation" becomes "user guide".

Checks

  • An independent pass checked the guide against the code and the 1.6.0 --help, and its corrections are in.
  • A link check found 0 broken relative links or anchors, including the anchors the app opens, also with the three docs PRs merged together.

docs/README.md gets a table of contents and task-oriented sections: quick start,
running apps, projects and worktrees, domains and routes, coding agents, Localify
Cloud, other devices, Docker, a reference and troubleshooting. It now covers service
tabs, relaunching with --replace, launch profiles, plans and billing, and remote
machines, and links to the feature docs instead of repeating them.

Every anchor the desktop app, the changelog and the issue template link to is kept.
@teo-goulois
teo-goulois merged commit 225d489 into main Nov 9, 2026
4 checks passed
@teo-goulois
teo-goulois deleted the docs/user-guide branch November 9, 2026 20: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