Skip to content

docs(ibkr): distinguish Gateway setup from TWS guidance - #1750

Draft
luokerenx4 wants to merge 1 commit into
devfrom
codex/161-ib-gateway-guidance
Draft

luokerenx4 wants to merge 1 commit into
devfrom
codex/161-ib-gateway-guidance

Conversation

@luokerenx4

@luokerenx4 luokerenx4 commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

IB Gateway users are told to enable a TWS-only checkbox when connecting their broker, sending them to a setting they cannot find (#161). This draft changes one hint in the existing broker preset catalog.

flowchart LR
  subgraph Before
    A[Choose IBKR] --> B[Shared preset hint says enable TWS checkbox]
    B --> C[Gateway user searches for missing setting]
    C --> D[Failure: setup guidance cannot be followed]
  end
  subgraph After
    E[Choose IBKR] --> F[Same preset and same setup dialog]
    F --> G[TWS user enables TWS socket checkbox]
    F --> H[Gateway user uses default socket API access]
    G --> I[Match configured port to running application]
    H --> I
  end
Loading

The hint now distinguishes TWS and Gateway, labels each application's live/paper port defaults, and directs the user to match the actual configured Socket port. The existing catalog, serialization and hint renderer remain the only owners. No application selector, new configuration field, port auto-detection or broker behavior is introduced. Both instructions remain visible because the current preset represents both applications; this is the smallest correction to the misleading path.

Checked against IBKR's initial setup documentation, which explicitly distinguishes TWS opt-in from Gateway's default socket access, and the current TWS configuration guide. No runtime permission or read-only setting is changed.

Verification:

  • pnpm -F @traderalice/uta-protocol typecheck: passed after building its IBKR workspace dependency.
  • Protocol package selection: 2 tests passed.
  • Existing CreateUTADialog suite: 7 tests passed.
  • pnpm exec tsc -b ui: passed.
  • git diff --check: passed.
  • Chromium demo walkthrough: Settings → Broker → Add UTA → IBKR → Configure, at 1280px and 390px. The actual built protocol preset and an installed-pack fixture were injected into the existing demo responses (the shipped demo offers only Alpaca/OKX); both application instructions render, and the mobile page stays 390px wide. No connection or save was submitted.
  • No TWS/Gateway desktop or broker connection test was performed.

Scope: one catalog string. Relates to #161; do not close the issue until accepted.

Included increment: one shared setup hint corrected (e0c8d9f3).

Remote verification: pushed head e0c8d9f3f750c85d628477aeeff745760b02d407 matches GitHub and targets dev as a Draft. clean-build, Vercel and Vercel Preview Comments passed at this exact head.

Final CI verification: clean-build run 36995902521 completed successfully for pushed SHA e0c8d9f3f750c85d628477aeeff745760b02d407; Vercel checks passed.

@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
openalice-demo Ready Ready Preview Oct 2, 2026 10:32am UTC

Request Review

@luokerenx4 luokerenx4 added area:onboarding First-run setup and onboarding recovery paths theme:reliability Failure recovery, retries, loading, or resilience workflow:parallel Autonomous parallel contribution; leave open for later acceptance labels Oct 2, 2026 — with ChatGPT Codex Connector

This branch was successfully deployed

1 active deployment
Preview — e0c8d9f3 Deployed Oct 2, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:onboarding First-run setup and onboarding recovery paths theme:reliability Failure recovery, retries, loading, or resilience workflow:parallel Autonomous parallel contribution; leave open for later acceptance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants