docs(option): rename /list/roots → /list/symbols#519
Merged
Conversation
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.
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
1 participant
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.
Summary
Page URL slug stayed `roots` after the SDK rename to `option_list_symbols` — https://userfrm.github.io/ThetaDataDx/historical/option/list/roots showed `option_list_roots` H1 / title with `option_list_symbols` code examples in the body. Fix the URL slug, the H1, the title, the prose, and the nav-bar label.
Change
Test plan