docs: fix strict build + update all docs for v7.0.0#473
Conversation
Fixes the failing `mkdocs build --strict` Docs workflow (pre-existing, broken since the v6.0.0 merge) and brings the docs current for v7.0.0. Build fix (docs/migration.md): - `../CHANGELOG.md` → absolute GitHub URL (the cross-tree link failed strict mode). - Broken `#v5--v600` anchor → `#v5-v600`. v7.0.0 accuracy: - New "v6 → v7.0.0" migration section (price_cents→price, announcements soft-deprecation, the 3 new endpoints, exchange_index/asset_class additions). - subaccounts: transfer_position `price_cents` → `price` (Decimal dollars) in the quick-ref table, prose, and example; netting example fixed to use `netting_configs` (+ `exchange_index`); dropped a stale field reference. - exchange: announcements deprecation admonition; corrected the example to the real model fields (`type`/`message`/`delivery_time`/`status`, not `title`). - pagination: note announcements is deprecated/404s. - portfolio: `balance(*, exchange_index=...)` param. - perps: note the two new klear margin methods. - OpenAPI version bumped 3.23.0 → 3.24.0 in README, docs/index.md, CLAUDE.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ReviewDocs-only PR that fixes the One small accuracy gap: README.md:14, docs/index.md:6, CLAUDE.md:125 — operation count still says "101 operations" despite this PR documenting a genuinely new main-API operation.
Everything else — the broken-link fix, the anchor fix, the new migration section, and all the per-resource doc updates — looks accurate and ready to land. Nice, thorough work verifying examples against actual signatures. |
Summary
Fixes the failing
Docsworkflow (mkdocs build --strict, broken since the v6.0.0 merge) and brings all docs current for v7.0.0. Docs-only — no code, no wheel impact.The build failure
mkdocs build --strictaborted on a broken link indocs/migration.md:[changelog](../CHANGELOG.md)— a cross-tree link mkdocs can't resolve (CHANGELOG lives at the repo root, not underdocs/). Switched to the absolute GitHub URL, matching the working pattern already used elsewhere in the file.#v5--v600→#v5-v600.v7.0.0 accuracy
v6 → v7.0.0migration section —price_cents→price, announcements soft-deprecation, the 3 new endpoints, and the additive field/param additions, with a migration snippet.transfer_positionprice_cents→price(Decimaldollars) in the quick-ref table, prose, and example; netting example fixed to iteratenetting_configs(+ show the newexchange_index); removed a stalenetting_enabled_subaccountsreference.announcements(); corrected the example to the actual model fields (type/message/delivery_time/status, not the non-existenttitle).announcements()is deprecated / 404s.balance(*, exchange_index=...)param.active_obligations,settlement_estimate_by_asset_class).3.23.0→3.24.0in README,docs/index.md, andCLAUDE.md(historical "when added" refs left intact).Test plan
uv run --group docs mkdocs build --strict— builds clean (was aborting)ruff/mypy/ tests unaffectedThis should land before tagging v7.0.0 so the release commit's docs are accurate and the Docs site rebuilds green.