Skip to content

docs: add WebSocket usage + reorganize README/docs - #183

Merged
martinkersner merged 1 commit into
mainfrom
worktree-readme-ws-docs
Jul 6, 2026
Merged

docs: add WebSocket usage + reorganize README/docs#183
martinkersner merged 1 commit into
mainfrom
worktree-readme-ws-docs

Conversation

@martinkersner

Copy link
Copy Markdown
Member

Summary

Documents the WebSocket client (previously undocumented in both the README and the docs site) and reorganizes the README/docs so it reads like a modern SDK guide. Moderate reorg — no code changes.

README

  • Overview up top (REST / WebSocket / Sync-or-async at a glance) + extras table ([async], [ws]).
  • ConfigurationAuthentication; env-var note kept.
  • 3-tab Quickstart: Sync | Async | WebSocket.
  • New Clients table.
  • REST API Reference regrouped by product: CEX / Derivatives and Leverage / Pricing and Cross-Exchange / Alternative Data — and folds in 5 endpoints that were undocumented in the README (liquidation, open interest, margin borrow, index price, cex.symbol), with signatures taken from the existing per-endpoint docs pages.
  • New full WebSockets section: install, quickstart, channel table (9 accessors + param formats + plan tier), multiplexing/msg["s"] filtering, firehose feed, reconnect/keepalive, lifecycle, message shapes.

docs

  • New docs/websocket.md (prose + auto-generated AsyncDatamaxiWS reference), added to the nav after Async Client.
  • docs/index.md is a symlink to ../README.md, so the reorganized content (incl. WebSockets) flows to the docs home automatically — left intact.

Tests

  • mkdocs build --strict passes clean (only a pre-existing INFO about the LICENSE relative link).
  • Confirmed the WebSocket page, the AsyncDatamaxiWS reference block, and the nav entry all render.
  • Sanity-checked the WS client at import: all 9 accessors + param_format resolve.
  • No source changes, so the pytest suite is unaffected.

Known failures

None.

README: overview at top, extras table, Configuration->Authentication,
3-tab Quickstart (Sync/Async/WebSocket), Clients table, REST reference
regrouped by product (CEX / Derivatives / Pricing / Alt-data) with the
5 previously-undocumented endpoints (liquidation, open_interest,
margin_borrow, index_price, cex.symbol) folded in, full WebSockets
section (channels, multiplexing, feeds, reconnect/keepalive, lifecycle).

docs: new websocket.md (+ AsyncDatamaxiWS reference) in nav after Async
Client. docs/index.md is a symlink to README so the WS content flows to
the docs home automatically.

Verified: mkdocs build --strict passes.
@martinkersner martinkersner self-assigned this Jul 6, 2026
@martinkersner
martinkersner merged commit 7f450f5 into main Jul 6, 2026
5 checks passed
@martinkersner
martinkersner deleted the worktree-readme-ws-docs branch July 6, 2026 04:16
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