Skip to content

Fix contradictions and broken links across docs pages - #2727

Merged
AlexCatarino merged 5 commits into
QuantConnect:masterfrom
AlexCatarino:bug-docs-consistency-fixes
Sep 29, 2026
Merged

AlexCatarino merged 5 commits into
QuantConnect:masterfrom
AlexCatarino:bug-docs-consistency-fixes

Conversation

@AlexCatarino

Copy link
Copy Markdown
Member

One commit per issue:

  • Patch File was tagged 04 like Delete File, so the delete-file page showed /files/patch. It's now 05, with its own metadata.json and 00.json entry.
  • Forex and CFD quote history said the DataFrame includes bid/ask sizes. The shared text now respects $supportsQuoteSize.
  • Index has no tick data, but the Research pages showed tick history requests (one with an undefined usb). Removed them and set $supportsTicks = false.
  • Candlestick patterns had no definitions. LEAN's doc comments only name each pattern, so the generator now reads one-line definitions from Resources/indicators/candlestick-pattern-definitions.json. The 61 pages are updated to match its output.
  • Link checker errors: replaced the removed Indexology post and the link to the private Lean.DataSource.CBOE repo, and added Groups3F to the checker's anchor map.

The two Specification Over Time pages are generated from the dataset listing. Update the Indexology link in the listing too, or the next generator run brings it back.

The Know Sure Thing intro fix is in QuantConnect/Lean#9846 and reaches these pages on the next generator run.

Test plan: url_check.py passes with 0 errors. The docs-style linter finds nothing in the new candlestick text. I rendered quotebars.php with both flag values.

AlexCatarino and others added 5 commits September 29, 2026 21:49
Both endpoints were tagged 04, so the delete-file page rendered the /files/patch content.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Forex and CFD data has no bid or ask sizes, but the shared text said the DataFrame includes them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Index data has no tick resolution, but the research pages showed tick history requests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
LEAN's doc comments only name each pattern, so the generator now reads one-line definitions from a JSON file.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the removed Indexology post and the private Lean.DataSource.CBOE link, and teach the checker the Position Groups%3F anchor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AlexCatarino
AlexCatarino merged commit 1f8c17b into QuantConnect:master Sep 29, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the bug-docs-consistency-fixes branch September 29, 2026 21:09
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