Repository navigation
docs: restructure the user guide around tasks, and bring it up to 1.6.0 - #90
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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#configurationand#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
localify devdoes 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.Restart,Open a terminal here, andReload shell environment.init-project.--env,copy-env.subscribe,--yearly,--machines,--url-packs,billing, and suspended URLs.localify machines pair, and the three settings;--help.X-Forwarded-Port, which the proxy sends, is now listed.Removed, and why
localify restartafter registering": stale. Since 1.1.0 a domain works whenregisterreturns, and unknown.localifynames get on-demand certificates.~/.config/localify/.Nothing claims the remote
--machineCLI flags or MCPmachinearguments described in remote-machines.md: they aren't in 1.6.0.docs/linux.md: "main documentation" becomes "user guide".Checks
--help, and its corrections are in.