Skip to content

docs: correct hosted Relay, sign-in, and privacy documentation - #3730

Merged
bobleer merged 1 commit into
GCWing:mainfrom
bobleer:bob/docs-relay-accuracy
Nov 4, 2026
Merged

bobleer merged 1 commit into
GCWing:mainfrom
bobleer:bob/docs-relay-accuracy

Conversation

@bobleer

@bobleer bobleer commented Nov 4, 2026

Copy link
Copy Markdown
Collaborator

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.

  • Add bilingual Relay FAQs covering account sign-in, online identity dependencies, same-network connections, private builds, privacy boundaries, availability, technical limits, and the absence of published pricing/SLA terms in this repository.
  • Correct GitHub-only descriptions to reflect independent GitHub/email accounts and older-client compatibility. Clarify that official and embedded LAN connections can coexist, while My devices/Peer/account-device dispatch retain the official account route.
  • Update the Playbook source catalog and generated projections, Desktop/mobile/operator documentation, developer guides, and all three Relay homepage locales, including its HTML fallback copy.
  • Correct the README's remote-workspace runtime description and two related identity-doc inconsistencies (independent provider availability and eight-digit email codes).

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

  • Refreshed upstream main at f219beeb72 before editing and again before submission; the README contradiction was still present.
  • Inspected open PRs including drafts and the remote/privacy diffs in [WIP]docs: refresh bilingual wiki text for OpenBitFun 1.0 #3098. That draft adds separate Wiki sources and does not change these existing README/catalog/operator files. This PR fills those gaps; it does not publish or duplicate the Wiki refresh.
  • Cross-checked the fixed endpoint and invitation restrictions, shared account identity/methods=all compatibility, device crypto, the independent dual-Relay fixture, and remote-workspace runtime ownership. FAQ implementation links preserve these references.
  • Read-only check of the public identity /api/v1/config on 2026-11-04 reported both githubAuthConfigured and emailAuthConfigured enabled. This was not an authenticated login test.

Verification

  • pnpm run capabilities:generate and pnpm 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.
  • Local Markdown target/anchor check — 104 links passed.
  • Local headless Chrome copy checks at 1280×900 and 390×844, in English, Simplified Chinese, and Traditional Chinese — all six combinations passed with no text clipping or page-script errors; desktop and scrolled mobile screenshots reviewed.

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

  • Focused changes; no secrets, scratch files, local paths, or unrelated artifacts.
  • Relevant verification and skipped runtime checks are recorded.
  • User-facing docs, generated catalogs, and applicable locales are updated together.

@bobleer
bobleer merged commit 8ccdb0f into GCWing:main Nov 4, 2026
12 checks passed
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