QuantConnect / QuantConnect/Documentation

Review Brokerage Repo Readmes

Open
#1,575 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

impact-medium
Dominant language
HTML
Stars
261
Forks
191
Avg merge
16h 28m
Merged PRs (30d)
56

Description

Expected Behavior

The brokerage repo readmes (example) have up-to-date information and all links are functional

Actual Behavior

These brokerage repo readmes fall out-of-date over time. For example, one of the terminal outputs on the Coinbase repo includes brokerages that we don't even support anymore.

    $ lean live 'My Project'
     
    Select a brokerage:
    1. Paper Trading
    2. Interactive Brokers
    3. Tradier
    4. OANDA
    5. Bitfinex
    6. Coinbase Pro
    7. Binance
    8. Zerodha
    9. Samco
    10. Terminal Link
    11. Atreyu
    12. Trading Technologies
    13. Kraken
    14. FTX
    Enter an option: 

The Coinbase repo even includes steps in the deployment process that are no longer required. For example, the deployment wizard support existing holdings now, but the repo doesn't reflect this.

Moreover, the readmes have broken links. We should extend the automated link checker to scan the links on these brokerage/dataset repos.

Checklist
  • I have completely filled out this template
  • I have confirmed that this issue exists on the current master branch
  • I have confirmed that this is not a duplicate issue by searching issues

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Coinbase README and the brokerage and dataset repository READMEs, noting outdated terminal output, deployment steps, and broken links. Then locate the automated link checker mentioned in the issue; done means the README information is current, links work, and those repositories are covered by the checker.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.