docs: sweep stale root/exp_date refs across doc tree (closes #503)#504
Merged
Conversation
Post-#484 (8.0.28) follow-up. The Rust SDK rename Contract.root -> Contract.symbol and Contract.exp_date -> Contract.expiration was not propagated to the doc tree. Sweep brings the docs into alignment with the SDK surface; wire codecs (FPSS binary frames, MDDS gRPC) are unchanged. Touched: - docs/api-reference.md - Rust struct definitions and prose - docs/macro-guide.md - parsed_endpoint! example query block - docs/architecture.md - clarifies that the FPSS binary diagram labels are wire-format names, not SDK struct names - docs/java-parity-checklist.md - top-of-file vocabulary note plus Rust-side rewrites; Java-side root/expDate references kept verbatim - docs-site/docs/api-reference.md - field tables and prose - docs-site/docs/streaming/{connection,events}.md - inline comments - docs-site/docs/historical/option/list/roots.md - prose only; URL slug preserved for inbound-link stability - docs-site/docs/historical/option/list/contracts.md - JSON sample, response table, and Go example (t.Root -> t.Symbol) - docs-site/public/thetadatadx.yaml - OpenAPI schema for Contract - sdks/cpp/README.md - OptionContract surface row Version bump 8.0.33 -> 8.0.35 across all manifests; sub-Cargo.lock files updated (8.0.34 placeholder is reserved for Wave 2A's parallel work-stream). CHANGELOG entry added under [8.0.35] in both CHANGELOG.md and the docs-site mirror. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Post-#484 (8.0.28) follow-up. The Rust SDK rename
Contract.root->Contract.symbolandContract.exp_date->Contract.expirationwas not propagated to the doc tree at the time. This PR brings the docs into alignment with the SDK surface. Wire codecs (FPSS binary frames, MDDS gRPC) are unchanged.Closes #503.
Files touched (per-rule)
docs/api-reference.mdContractandOptionContractRust struct fields renamed (root/exp_date->symbol/expiration); "String root field" prose updated to "String symbol field".docs/macro-guide.mdparsed_endpoint!example query block:root: symbol.to_string()->symbol: symbol.to_string().docs/architecture.mdroot_len,root,exp_date) are the on-the-wire field names; the diagrams remain accurate as-is because the FPSS streaming wire format is unchanged. The Rust SDK exposes these assymbolandexpiration, and MDDS gRPC v3 usessymbolnatively.docs/java-parity-checklist.mdContract::option(symbol, expiration, strike, right)andContract symbol length check. Java-sideroot/expDatereferences kept verbatim (Java terminal vocabulary is unchanged).Contract::option_rawmention reworded to flag the futureIntoOptionSpecshape, deferred to 9.0.0.docs-site/docs/api-reference.mdroot/exp_date->symbol/expiration. Prose:OptionContractrecords list updated.docs-site/docs/streaming/connection.mddocs-site/docs/streaming/events.md.exp_date/ ...)" -> "(plus.expiration/ ...)"..is_calland.strikeare still correct.docs-site/docs/historical/option/list/roots.mdroots.mdslug is referenced fromhistorical/option/index.mdand the VitePress sidebar). Prose updated to clarify the SDK method isoption_list_symbols; the legacy "roots" term is preserved in the slug only. No file rename.docs-site/docs/historical/option/list/contracts.mdsymbol(matchesOptionContractstruct on every SDK). Go example fixed:t.Root->t.Symbol(the Go SDK struct usesSymbolsince #484). Note added: there is no raw JSON wire format on this endpoint — the response decodes from a v3 gRPCDataTable, so the SDK'ssymbolvocabulary is what callers see.sdks/cpp/README.mdroot, expiration, strike, right->symbol, expiration, strike, right.Out-of-list cleanup
docs-site/public/thetadatadx.yaml— OpenAPIContractschema also had staleroot/exp_dateproperties. Updated for consistency. The path/operationId drift checks still pass (scripts/check_docs_consistency.py).Final scrub
rg "\\.root\\b|\\bexp_date\\b|\\.expDate\\b" docs/ docs-site/ sdks/*/README.md README.md ROADMAP.mdreturns only:docs-site/docs/changelog.md— frozen historical entries (including the new 8.0.35 entry that describes the sweep).docs/architecture.md— the FPSS wire-format byte labels, intentionally preserved with explanation.No prose references to the Rust SDK using
root/exp_dateremain.Version
scripts/bump_version.py8.0.33 -> 8.0.35 across all manifests. The 8.0.34 slot is reserved for the parallel Wave 2A work-stream; per the V8 patch-bump-only policy, this PR rides 8.0.35 once Wave 2A merges. If the merge order needs to be different, the reviewer can swap the version bump locally before squash-merge.scripts/check_version_sync.py: ok at 8.0.35.scripts/check_docs_consistency.py: ok.Test plan
cargo fmt --all -- --checkcleancargo test --workspacepasses (incl. all doc-tests)cargo clippy --workspace --all-targets -- -D warningscleanpython3 scripts/check_docs_consistency.pyokpython3 scripts/check_version_sync.pyok at 8.0.35