Trim overlong frontmatter descriptions for SEO#24
Open
mintlify[bot] wants to merge 138 commits into
Open
Conversation
Implements the AI System Improvement initiative (Phases A–D):
Phase A — Governance:
- Add ai/RULES.md: all binding rules (AI behavior, pipeline gates, commit
protocol, validation, content rules, self-improvement policy)
- Add ai/LESSONS.md: pattern-triggered accumulated lessons (empty scaffold)
- Slim CLAUDE.md to 53 lines (was 23 rules inline); all rules migrated to
ai/RULES.md; add Commands section, Skills table, Key Files table
- Add AGENTS.md: agent-agnostic entry point for Kiro, Cursor, and others
Phase B — Skills system:
- Add ai/skills/ with 9 skill files (dev-ticket-pipeline, doc-review-pipeline,
task-self-review, self-improvement, promote-learnings, generate-docs-from-spec,
write-commit-message, create-initiative-spec, cleanup-after-pipeline)
- Update ai/agent.md: section 3 adds ai/skills/, ai/specs/, governance files;
section 5 replaces step-by-step pipelines with one-line skill references
Phase C — Claude Code Skills (official format):
- Add .claude/skills/ with 9 SKILL.md directories (official format, not
legacy .claude/commands/); all use disable-model-invocation: true;
write-commit-message uses dynamic git diff injection
Phase D — Initiative spec:
- Add ai/specs/ai-system-improvement/ and ai/specs/claude-skills-research/
(spec-driven pipeline used throughout; all phases complete)
chore(ai): add skills layer, governance files, and Claude Code skills
fix(api): add missing mining pool rewards fields
fix(api): typo
api(docs): change payoutDestination example in mining rewards response
added missing-schemas or validation
…ages, add nav links - Add GET /api/v1/public/kline (Market Data) — new MDX page and nav entry - Fix collateral open positions endpoint path: /positions → /positions/open in openapi/private/http-trade-v4.yaml and open-positions.mdx - Remove cancel-oco-order and cancel-oto-order pages, nav entries, and legacy redirects — endpoints no longer documented - Add \"We are hiring\" and GitHub (type: github) links to navbar - Add github social to footer socials
docs(api): add kline, fix positions endpoint, remove cancel OCO/OTO pages, add nav links
- Add guides/mcp-server.mdx — full setup guide for the whitebit-mcp trading server (115 tools); covers Claude Code, Cursor, Claude Desktop, Codex, and OpenClaw client configuration - Add guides/cli.mdx — CLI reference with commands, authentication, examples, and coming-soon install notice (source only for now) - Add guides/ai-faq.mdx — FAQ covering API key safety, supported clients, trading vs docs MCP disambiguation, automation, and safe account practices - Revamp guides/use-with-ai.mdx — full hub page with 4-card grid, feature breakdown by category, and supported AI clients table - Rename guides/ai-ide-setup.mdx → "Docs search via MCP"; add icon - Rename guides/ai-context-menu.mdx → "Docs page AI menu"; add icon - Update docs.json — rename group to "AI Hub", add 3 new pages to nav
docs(ai-hub): add AI Hub section with MCP server, CLI, and FAQ pages
…text - Rename "WhiteBIT MCP server" to "WhiteBIT documentation MCP server" in the IDE quick connect table to distinguish from the trading MCP server - Update frontmatter description to list actual supported tools (ChatGPT, Claude, Perplexity, Grok, Cursor, VS Code, Claude Desktop) instead of implying docs integrations exist for Claude Code / Codex / OpenClaw - Remove duplicate "via MCP via MCP" link text in two places
fix(ai-context-menu): clarify MCP server name and fix duplicate link text
Stage to main
Stage to main
… pages Implement the comprehensive Docs tab restructuring: 36+ new pages covering products (spot, margin, futures, lending, sub-accounts, mining, market data), integration guides (first API call, WebSocket quickstart, trading bot, payment integration, market maker, broker), institutional section (overview, onboarding, compliance), platform features (convert, WhiteBIT codes), best practices (security, go-live checklist), and core concepts (markets, balances). Enhance existing pages (index, FAQ, SDKs, authentication, rate limits, colocation, webhook). Add data-driven concept tables, validation checks, and navigation.
…nd status codes Address 8 review comment tasks from the docs tab rework: - Add HTTP status codes table to API overview using shared ConceptTable data (T3) - Link endpoint mentions to doc pages in go-live checklist (T5) - Document Demo Tokens (DBTC/DUSDT) across go-live checklist, first API call, FAQ, and spot quickstart (T4) - Add bidirectional cross-links between broker guide and client order ID (T8) - Document data/ → concept-data pipeline in agent.md (TAI) - Add SDK quickstart link to first API call prerequisites (T10) - Implement full account monitoring guide — balance queries, WebSocket streams, deposit/withdrawal tracking, order monitoring, polling vs WS matrix (T7) - Implement full trading bot guide — architecture, market data, order placement, kill-switch, fill monitoring, error handling, reconnection, grid bot example (T9)
…art trim Audit and improve five guide pages from review feedback: - Fix deals_subscribe params across account-monitoring and trading-bot guides (flat array → nested array per spec) - Add cURL/Python/wscat tabs, polling intervals table, and Main balance callout to account-monitoring guide - Add prerequisites, demo tokens warning, and client_order_id note to trading-bot guide - Add connection params (timeout, rate limit), demo tokens warning, and separate keepalive step to websocket-quickstart - Remove redundant Step 5 from spot quickstart, condense accordion, simplify cURL placeholder headers - Record three style-guide lessons in LESSONS.md
docs: add Docs tab with products, guides, concepts, and institutional pages
…y guidance Payment integration: add unique-address-per-user section, withdrawal-with-conversion tab with step-by-step flow and code examples, required endpoint tables, and cross-links from balances, integration paths, and convert pages. WebSocket: replace quickstart reconnection accordion with full reconnection and state recovery section — exponential backoff code, recovery strategy table by channel update model, and query-then-subscribe pattern. Add per-channel recovery hints and related resources to all 9 account-stream pages.
…SL error 30 Apply SME-confirmed answers (Q1.3, Q1.4, Q5.2) and new error code 30 (reduceOnly incompatible with stopLoss/takeProfit) across collateral order endpoints, concepts page, and glossary.
Documentation/new docs tab conent
Update the V4 OpenAPI spec and related MDX frontmatter to use the live endpoint paths (/api/v4/conditional-orders, /api/v4/oco-orders). The previously documented /api/v4/orders/conditional and /api/v4/orders/oco paths returned 404 against the real API.
Stage reduce-only release (2026-04-22) ahead of merge to main. - Remove "coming soon" notes from 8 API endpoint + 2 WebSocket pages plus concepts/order-types, glossary, and FAQ - Relabel changelog entry from "Coming soon" to "April 22, 2026" - Reorder error 116 JSON keys to code/errors/message, matching the actual API response shape (consistent with error 30)
The page description claimed the endpoint cancels "all spot orders," but the OpenAPI `types` enum and SME confirm it also targets margin and futures orders. Updates the frontmatter description to match.
Documentation/new docs tab conent
Both products/margin/overview.mdx and products/futures/overview.mdx used sidebarTitle "Overview", producing two adjacent "Overview" entries under the Margin & Futures group. Rename to "Margin" and "Futures" so the sidebar reads Compare Trading Types / Margin / Futures / Quickstart.
added new instructions for AI key input
Replace the broken `https://api.whitebit.com` REST base with the canonical `https://whitebit.com` across 18 guide, product, platform, and institutional pages (97 occurrences). The new host matches every `servers:` entry in openapi/public/http-v*.yaml and openapi/private/ *.yaml, and was live-verified against /api/v4/public/time (200). WebSocket URLs (wss://api.whitebit.com/ws) are intentionally unchanged — the `api.` subdomain is correct for the WS host per ai/specs/regional-base-urls/design.md DD-3. Follows phase B of ai/specs/regional-base-urls/; phase C (regional switcher coverage) is deferred until the EU domain is public.
Adopt `<RegionBaseUrl />` on every in-scope URL-bearing page that didn't already have it. Coverage now 63/63 pages across guides, products, platform, institutional, best-practices, websocket, api-reference/authentication, and index.
Adds a new "## WebSocket workflow for market making" section between Quoting strategy and Infrastructure best practices in the market-maker guide. The section is orchestration + cross-references only — no protocol code is duplicated. It maps MM data needs to the right pieces of the existing WebSocket Quickstart and Building a Trading Bot guides instead of restating them. Section content: - Lead paragraph describing the canonical spot MM loop (depth or bookTicker for quote inputs → REST place/modify → ordersPending state transition → deals fill → balanceSpot delta → recompute) - 5-row channel table for spot (depth, bookTicker, balanceSpot, ordersPending, deals) with recovery model and per-row link to the relevant section of WS Quickstart or Bot Guide - 2-row futures additions table (positions snapshot, marginPositionsEvents) for perpetual quoting - Canonical 4-message subscribe set as a single JSON block, with an authorize-prerequisite preamble pointing back to the WS Quickstart auth step - Note on the documented asymmetry between ordersPending_subscribe (flat array) and deals_subscribe (nested array) - bookTicker row notes that bookTicker_update excludes RPI orders, so RPI-mode MMs must rely on private active-orders state instead Five gating checks ran before writing, all confirmed: - Mintlify <Step> components produce kebab-case anchors (verified via existing live cross-link in guides/account-monitoring.mdx to #authenticate-for-private-channels) - deals_subscribe params shape is [["BTC_USDT"]] per asyncapi/private/deals.yaml lines 160-166 (deliberate asymmetry vs ordersPending_subscribe) - websocket/market-streams/book-ticker.mdx already has a subscribe example via <WsSubscribeSteps> — no dead-end on the table row - All H2/H3 cross-link slugs (#state-recovery-after-reconnect, #websocket-fill-monitoring, #reconnection-and-state-recovery, #subscribe-to-orderbook-depth) confirmed in use by 6 existing cross-links across the docs - bookTicker_subscribe + depth_subscribe live-tested against prod wss://api.whitebit.com/ws — both return success; first bookTicker_update arrived in <1s with the documented array shape - BTC_PERP confirmed live in /api/v4/public/markets Also ships the full audit report at ai/outputs/market-maker-guide-audit-2026-04-24.md, documenting all three passes (initial breakage audit, content additions, this WebSocket workflow addition) with per-call live logs, spec diffs, self-review, and post-fix resolution table. Validation: node validate.mjs --mdx --changed → mdx, nav, content all pass.
Two unverified or self-contradictory assertions in the colocation section. Both surfaced by the live audit at ai/outputs/market-maker-guide-audit-2026-04-24.md and deferred at the time pending engineering confirmation; resolving them now by aligning the guide to documented evidence rather than blocking on out-of-band confirmation. - AWS region codes (eu-central-1 / ap-northeast-1) were asserted in this guide only and not present in the canonical platform/colocation.mdx page. A reader provisioning to the wrong AWS region on the strength of an unsourced doc claim would lose the "3-5 ms" latency the same paragraph promises. Removed the AWS Region column and added a sentence directing readers to the account manager — same advice the colocation page already gives. - The "34 endpoints" claim in both the colocation Warning and the Available endpoints section intro contradicted the enumerated total (15 spot + 14 collateral + 4 utility = 33). The in-source comment flagged this as an open question. Resolved by aligning the prose to the documented evidence (33), since the "34" was asserted only in a comment, never enumerated. If engineering later confirms a 34th endpoint, add the row and bump the count. Audit report's "Open engineering questions" row updated to reflect all three originally-deferred items now resolved (the third — modify queue priority — was already resolved from spec in the prior commit). Validation: node validate.mjs --mdx --changed → mdx, nav, content all pass.
Documentation/new docs tab conent
… Integration Guides Promote these three guides to the top level of the Integration Guides sidebar group so they're reachable without expanding a sub-section. Removes the now-empty Partner Programs group.
docs(nav): surface trading bot, market maker, and broker guides under Integration Guides
Stage to main
Shorten descriptions on four pages that exceeded the 160-character SEO limit. Rewrites preserve the page's topic and key terms in plain language without changing page content. Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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
Audited all MDX pages for SEO metadata quality and shortened four
descriptionvalues that exceeded the 160-character limit. No page content was modified.Pages updated
best-practices/go-live-checklist.mdx— 169 → 160 charsguides/payment-integration.mdx— 206 → 152 charsplatform/colocation.mdx— 464 → 144 chars (also stripped embedded markdown links that don't render in meta descriptions)platform/self-trade-prevention.mdx— 209 → 127 charsAudit results
The 2 files in
snippets/lack frontmatter intentionally — they are reusable content fragments, not standalone pages, so they don't need SEO metadata.