Repository navigation
docs(ibkr): distinguish Gateway setup from TWS guidance - #1750
Draft
luokerenx4 wants to merge 1 commit into
Draft
luokerenx4 wants to merge 1 commit into
luokerenx4 wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
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 endThe 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.pnpm exec tsc -b ui: passed.git diff --check: passed.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
e0c8d9f3f750c85d628477aeeff745760b02d407matches GitHub and targetsdevas 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.