QuantDesk docs
Documentation for product, guides, and developers — similar in spirit to strong platforms (clear product story first, then deep guides, then API truth in Swagger). Internal engineering notes stay in the repo root underdocs/.
How this site is organized
1 — Product and vision
What we’re building, what’s broken in crypto finance we care about, and how QuantDesk fits. Start here:- What is QuantDesk? — problem, gap, direction
- Features and tools — capability map with honest status labels
- Visual product tour — screenshot placeholders (swap in real captures later)
- Uniques and roadmap — shipped vs prototype vs roadmap
- Why QuantDesk — values in short form
2 — Guides (typical docs)
Step-by-step usage for traders and operators.- Start in 5 minutes
- Trading — Lite/Pro, orders, book, shortcuts
- Social — product direction, labeled honestly
- Security and trust
- FAQ hub — Wallet & network, Orders & risk
3 — Developers (funnel + copy-paste)
Integrate like Coinbase-style dev docs: quick path first, then schema in Swagger.- Developer quickstart —
curl, Swagger, first API call - Authentication
- API overview
- Swagger UI:
http://localhost:3002/api/docs/locally (same path on your deployed API origin)
Quick lanes
| Lane | Start |
|---|---|
| I’m evaluating the product | What is QuantDesk? → Features and tools |
| I want to trade | Start in 5 minutes → Trading overview |
| I’m integrating / automating | Developer quickstart |
What this site optimizes for
- Product clarity — vision and gaps in crypto finance, not only API endpoints
- Feature honesty — shipped / prototype / roadmap labels where it matters
- Guide depth — trading and ops flows readers can follow
- Developer ergonomics — copy-paste checks; OpenAPI as single schema truth