Skip to content

Add OKX SDK documentation and guides - #34

Open
MiniTiago wants to merge 22 commits into
mainfrom
docs/okx-sdk
Open

MiniTiago wants to merge 22 commits into
mainfrom
docs/okx-sdk

Conversation

@MiniTiago

@MiniTiago MiniTiago commented Nov 11, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add 16 OKX REST and WebSocket documentation pages and 11 source examples, including passive account streams with REST recovery and regional/demo configuration.
  • Add eight runtime setups and generated starter projects, plus browser/native compatibility recipes.
  • Integrate okx-api 3.2.9 into reference generation, release tracking, Dependabot and existing checks.

Verification

  • Passed all 11 source examples, strict published-package TypeScript checks, React/Vite builds, 62 content/release/CI/analytics tests and validation of all 48 generated starter projects.
  • Generated and rendered 568 API reference pages from the exact npm release source; rendered 24 authored/runtime guides and checked 105 authored internal links and anchors.
  • Verified all 97 uploaded files match the local reviewed files byte for byte.
  • Full local bundling was stopped by environment resource limits. The full GitHub CI build passed for head 369d3f5, including all six SDK sites and validated artifact upload.
  • A public REST check timed out. No private or trading requests were executed.

This branch has not been deployed

No deployments
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