Skip to content

Commit 46f9012

Browse files
committed
docs(option): rename /list/roots → /list/symbols + nav label fix
User reported https://userfrm.github.io/ThetaDataDx/historical/option/list/roots showed `option_list_roots` H1 / title with `option_list_symbols` code examples in the body. Page URL slug stayed `roots` after the SDK rename to `option_list_symbols`, leaving the public docs page internally inconsistent. - `docs-site/docs/historical/option/list/roots.md` → `symbols.md` (git mv preserves history). - H1 + frontmatter title + description: `option_list_roots` → `option_list_symbols`. - Page prose: dropped the `(roots)` parenthetical from the first paragraph and the "legacy 'roots' term preserved in URL slug" note — there is no legacy slug anymore. - `docs-site/docs/historical/option/index.md`: `./list/roots` → `./list/symbols` link + "List Roots" → "List Symbols" label. - `docs-site/docs/.vitepress/config.ts`: nav-bar label `Roots` → `Symbols` (the link was already pointing at `/list/symbols`). `docs-site` build will regenerate `.vitepress/dist/` next deploy. Inbound links to the old URL will 404; that is the cost of the rename — the URL was internally lying about its content for the entire v9.1.0 / v10.0.0 wave. Pre-push pipeline: cargo run -p thetadatadx --bin generate_sdk_surfaces --check, python3 scripts/check_docs_consistency.py — both green.
1 parent 79db040 commit 46f9012

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs-site/docs/.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export default withMermaid(defineConfig({
128128
text: 'List',
129129
collapsed: true,
130130
items: [
131-
{ text: 'Roots', link: '/historical/option/list/roots' },
131+
{ text: 'Symbols', link: '/historical/option/list/symbols' },
132132
{ text: 'Dates', link: '/historical/option/list/dates' },
133133
{ text: 'Strikes', link: '/historical/option/list/strikes' },
134134
{ text: 'Expirations', link: '/historical/option/list/expirations' },

docs-site/docs/historical/option/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ Option contracts are identified by four parameters:
2222

2323
## Endpoint Categories
2424

25-
### [List](./list/roots) (5 endpoints)
25+
### [List](./list/symbols) (5 endpoints)
2626

2727
Discover available symbols, expirations, strikes, dates, and contracts.
2828

29-
- [List Roots](./list/roots) - all option underlying symbols
29+
- [List Symbols](./list/symbols) - all option underlying symbols
3030
- [List Dates](./list/dates) - available dates for a contract
3131
- [List Strikes](./list/strikes) - strike prices for an expiration
3232
- [List Expirations](./list/expirations) - expiration dates for an underlying

docs-site/docs/historical/option/list/roots.md renamed to docs-site/docs/historical/option/list/symbols.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: option_list_roots
2+
title: option_list_symbols
33
description: List all available option underlying symbols.
44
---
55

6-
# option_list_roots
6+
# option_list_symbols
77

88
<TierBadge tier="free" />
99

10-
List all available option underlying symbols (roots). Use this to discover which tickers have option chains available in ThetaData.
10+
List all available option underlying symbols. Use this to discover which tickers have option chains available in ThetaData.
1111

1212
## Code Example
1313

@@ -60,4 +60,4 @@ None.
6060
## Notes
6161

6262
- Returns all underlying symbols, not individual contracts. Use [option_list_expirations](./expirations) and [option_list_strikes](./strikes) to drill into a specific chain.
63-
- The Rust SDK method is `option_list_symbols`. The legacy "roots" term is preserved in this page's URL slug for inbound-link stability; the SDK and protobuf surface use `symbol` exclusively.
63+
- The Rust SDK method is `option_list_symbols`. The SDK and protobuf surface use `symbol` exclusively.

0 commit comments

Comments
 (0)