Skip to content

[docs] Reconcile runtime docs with relay-only pags up #208

Description

@serge-ivo

Problem

Runtime documentation disagrees with the current CLI/runtime implementation.

The implemented path is relay-only from the user perspective: pags up starts one multiplexed runner and runner connect connects via WebSocket relay. The CLI exposes pags up --headless, --instance, and --force; there is no pags up --tunnel option in the code.

Evidence

  • Current CLI options: platform/packages/cli/src/commands/up.ts
  • Relay connect implementation: platform/packages/cli/src/commands/runner/command.ts
  • Current public docs say relay-only: platform/platform-docs/browser-runtime.md
  • Stale/conflicting docs:
    • platform/README.md says cloudflared tunnels remain as --tunnel quick|named
    • platform/packages/browser-runner/README.md says Cloudflare quick tunnel is the shipped bootstrap path and mentions FAGS/outbound polling
    • platform/store/llms.txt and platform/store/llms-full.txt mention Cloudflare Tunnel as a legacy/optional path
    • platform/docs/coder-cloud-vs-local-placement.md still says local placement uses a tunnel

Scope

Update all runtime-related docs to one current story:

  • pags up is the canonical user command.
  • It starts one local runtime for all active runtime-backed instances on the machine.
  • It connects outbound through RelayDO/WebSocket.
  • No inbound tunnel/cloudflared setup is part of the current user path.
  • Document --force, --instance, and --headless only if they still exist.

Acceptance Criteria

  • No docs mention pags up --tunnel, Cloudflare quick tunnels, or FAGS runtime as current behavior.
  • platform/README.md, platform/packages/browser-runner/README.md, platform/platform-docs/browser-runtime.md, platform/store/llms.txt, and platform/store/llms-full.txt agree.
  • pnpm docs:build is run if platform-docs sources change.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions