docs: add WebSocket usage + reorganize README/docs - #183
Merged
Conversation
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.
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
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
[async],[ws]).Configuration→Authentication; env-var note kept.cex.symbol), with signatures taken from the existing per-endpoint docs pages.msg["s"]filtering, firehose feed, reconnect/keepalive, lifecycle, message shapes.docs
docs/websocket.md(prose + auto-generatedAsyncDatamaxiWSreference), added to the nav after Async Client.docs/index.mdis a symlink to../README.md, so the reorganized content (incl. WebSockets) flows to the docs home automatically — left intact.Tests
mkdocs build --strictpasses clean (only a pre-existing INFO about theLICENSErelative link).AsyncDatamaxiWSreference block, and the nav entry all render.param_formatresolve.Known failures
None.