Repository navigation
docs: correct hosted Relay, sign-in, and privacy documentation - #3730
Merged
Merged
Conversation
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.
Summary
The main English and Chinese READMEs told users to deploy a Relay, while their linked operator guide described a hosted official service. Replace that contradiction with the supported connection paths and make official Relay, no deployment required visible in the main remote-control section.
Type and Areas
Type: docs / public copy
Areas: README, Remote Connect, account identity, Playbook, Relay homepage and deployment guidance.
Motivation / Impact
Before: “Relay server you deploy” / “由你自部署 Relay”; the Relay homepage emphasized self-hosting and pairing without explaining account authorization.
After: the official service is the default; LAN sign-in still needs the identity service; private Relay endpoints require matching client builds. Device-payload encryption is described separately from identity/routing metadata, Pages, model requests, and bot-provider traffic. Historical Beta wording is not treated as a permanent free-service or uptime guarantee.
Existing-fix and implementation checks
mainatf219beeb72before editing and again before submission; the README contradiction was still present.methods=allcompatibility, device crypto, the independent dual-Relay fixture, and remote-workspace runtime ownership. FAQ implementation links preserve these references./api/v1/configon 2026-11-04 reported bothgithubAuthConfiguredandemailAuthConfiguredenabled. This was not an authenticated login test.Verification
pnpm run capabilities:generateandpnpm run capabilities:check— passed.pnpm run capabilities:test— 16 tests passed.pnpm run i18n:audit— passed, zero warnings.node scripts/check-repo-hygiene.mjs— passed, 28 changed content files scanned.git diff --cached --check— passed.AI-assisted, lightly tested (documentation, generated-contract and local copy checks). No runtime behavior changes. No live remote workspace, remote control/mobile/IM, Peer Device Mode, or Detached Dispatch end-to-end scenarios were exercised; these checks do not establish service availability or remote behavior.
Reviewer Notes
Pricing, commercial quotas, and SLA remain operator policy questions; no numbers or permanent-free promises are invented. Runtime/API identifiers and compatibility paths are unchanged. Generated TypeScript changes only the catalog digest.
Checklist