Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1012 Bytes

File metadata and controls

32 lines (21 loc) · 1012 Bytes

Whale Docs

The documentation site for Longport Whale, built with Astro and Bun.

Whale Docs includes product documentation, WhaleSDK guides, BrokerAPI and TradingAPI references, and OpenAPI specifications in English, Simplified Chinese, and Traditional Chinese.

Documentation

Public documentation is available under three locale routes:

  • /en/
  • /zh-CN/
  • /zh-HK/

Documentation source files live in docs/. API references are generated from the OpenAPI specifications in the repository, and docs.json defines product and sidebar navigation.

Contributing

Read CONTRIBUTING.md for local development, documentation standards, API maintenance notes, and verification commands.

AI agents and human contributors must follow COPYWRITING.md when writing or reviewing public content.

Attribution

The site uses the Nimbus documentation application as its UI foundation with Whale branding and navigation. See NOTICE.md for attribution.