Fix spelling, grammar, and formatting errors across docs#6
Open
mintlify[bot] wants to merge 118 commits into
Open
Fix spelling, grammar, and formatting errors across docs#6mintlify[bot] wants to merge 118 commits into
mintlify[bot] wants to merge 118 commits into
Conversation
Repository migration initial commit
github workflow for mirroring was added;
…il-parameterfor-v4-order-bulk-endpoint DR-57: document missing stopOnFail for v4 order bulk endpoint
… according to the DR-57 task.
…l data required in API documentation. File main_api_v4.yaml.
…nfail-for-trade-v4-collateral-bulk-limit-order DR-63: documented stopOnFail behavior for collateral bulk limit order…
…osit-status-frozen-to-additional-data-required-in-api-documentation DR-52: Changed Withdrawal and Deposit Status from Frozen to Additiona…
… File main_api_v4.yaml.
…n-endpoint-docs DR-37: Updated the status code from 201 to 200 in JWT token endpoint.…
additional missing migration data
…PI-orders-and-sub-account-fees
…entation-for-RPI-orders-and-sub-account-fees DR-64: document RPI visibility, IOC incompatibility, and sub-account …
- Add POST /api/v4/main-account/refund-deposit to OpenAPI spec - Create refund-deposit.mdx page - Add to Main Balance navigation
- Require full file content for rule-by-rule style guide verification - Add systematic Step 2 (doc type, style guide mapping, explicit PASS/violation) - Add Rule Verification Summary and doc-type self-challenge questions - Replace mintlify dev with validate.mjs for linting - Create ai/prompts/cleanup.md for pipeline cleanup - Remove cleanup section from ai/prompts/commit_message.md - Update CLAUDE.md, agent.md, prompts README, playbook, outputs README
- Use active voice and reduce pronouns across definitions - Apply sentence case and parenthetical spacing per 12.2 - Wrap standalone Accordions in AccordionGroup - Fix WhiteBIT typo and cross-link anchors - Fix subject-verb agreement (Kill-switch, Provider)
- Add H2 category headings (rate limits, WebSocket, transfers, etc.) - Fix support link (mailto instead of FAQ page) - Add direct answers as first sentence in affected entries - Rephrase two questions to use first-person perspective - Link security and API usage answers to auth and WebSocket guides
…ndpoints - Add Authentication and Error codes sections to fee, asset-status-list, market-activity, depth - Add rate limit reference links to OpenAPI spec (ticker, assets, fee, depth) - Improve Depth endpoint description and OrderbookResponse schema - Use sentence case for Asset status list title
- Add commit gate: AI stops before commit; human performs commit - Add validate.mjs with --changed, timeouts, local binaries - Fix AsyncAPI $ref in balance_spot and positions - Add node_modules to .gitignore; exclude package.json from mirror - Update validation cheatsheet and task_completion_review prompt
- validate.mjs: add dual-mode component detection (Card, Frame) and MDX directory exclusion filtering (ai/, .kiro/, node_modules/) - base.md: add normative language (RFC 2119), pronoun prohibition, emoji prohibition, contractions prohibition, document metadata - api-endpoints.md: rewrite as normative specification v1.1 with enforcement rules, pronoun/emoji/contractions prohibitions, placeholder policy, pagination requirements, section ordering - websocket.md: replace "you must" with imperative mood, add AsyncAPI version matching requirement, document metadata - changelog.md: add breaking change requirements (10.4), metadata - faq.md: add linking requirement (7.2.3), document metadata - glossary.md: add 2-sentence definition limit, remove emoji, metadata - user-guides.md: add screenshot security requirements (6.4.5), metadata
Docs/api endpoints review
docs(api): add refund-deposit endpoint to Main API v4
…-fields fix(api): typo
…-fields 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
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
whitebit-robot
added a commit
that referenced
this pull request
Apr 1, 2026
DR-52: Changed Withdrawal and Deposit Status from Frozen to Additiona…
whitebit-robot
added a commit
that referenced
this pull request
May 27, 2026
Two-phase landing on top of f7ba1ab (2026-05-22 retro):
Phase 1 — Learning-consolidator deep run (2026-05-24)
Reduces ai/LESSONS.md from 78 entries (~510 lines) to 3 entries
(~75 lines). 42 archived, 18 promoted into RULES / skills / style
guides, 5 → 3 kept after self-review.
Promotions:
- RULES §3.2: MDX-comment-syntax rule ({/* */}; HTML comments
silently break Mintlify parsing).
- RULES §2.2: `concept` added to commit scope list; mirrored in
write-commit-message/SKILL.md.
- skill-creator Phase 5: registration step split into three
numbered sub-steps + `grep -l` verification command.
- ticket-analysis: peer-evidence pass for new endpoints joining
an established family (collapses BLOCKER SME questions);
enum-identifier disambiguation §4.1 subsection; discovery
sweep before CREATE classification.
- ticket-impl-plan: PENDING-vs-OMIT user decision promoted from
aside to Step 1.5 gate.
- dev-ticket-pipeline + ticket-analysis Step 1 + ticket-impl-plan
Step 1: multi-ticket suffixed-input-file detection.
- humanize-review SKILL.md: mandatory per-task checks #5
(source-page terminology + dimension) and #6 (section-minimum
floor for Family 1.x deletions). ai-voice-catalog Family 6.1
verification gate parallel to 6.2.
- base.md §3.2.5: primary vs secondary pronoun enforcement
levels. §5.2.7: -ing compound noun exception ("Error handling"
accepted; verb-phrase gerunds still rejected).
- product-pages.md: full §5–§9 restructure — Comparison pages
promoted to new top-level §6 with three subsections; Quickstart
§6 → §7; Shared rules §7 → §8; Checklists §8 → §9.
- api-endpoints.md §11: renamed to "Response documentation and
schema design" with intro distinguishing rendered-doc rules
(§11.1–4) from spec-design rules (§11.5–7). §11.5 cancel/ack
schema-reuse prohibition. §11.6 per-endpoint schema variance.
§11.7 shared-description-edit verification. §13.1 spec-driven
page channel for pagination.
Phase 2 — Adversarial self-review (2026-05-25)
Surfaced three critical cross-reference defects, five structural
improvements, two process rules, and one user-flagged security leak.
Critical fixes (cross-reference dangling pointers from Phase 1):
- New ai/skills/dev-ticket-pipeline/references/empirical-probe-
methodology.md captures the four V4 probe patterns
(live signed probing + signing pattern; two-variant
write-then-read; three-phase state-toggle; Cloudflare-Access
diagnostic). dev-ticket-pipeline empirical-probe paragraph
rewritten to point at the new reference instead of the three
archived 2026-04-29 LESSONS entries.
- ai/RULES.md §2.4 Source line rewritten to point at the
methodology reference + Amendment Log row, not the archived
LESSONS entry.
- ai/skills/answer-partner-questions/SKILL.md step 5 gained an
explicit 403-fallback paragraph — Zendesk blocks WebFetch and
curl regardless of User-Agent; do not retry with UAs or pivot
to competitor docs; ask user to paste the article body into
ai/inputs/<feature>-help-article.md. The ADL release resolved
9 of 25 SME questions this way.
Structural improvements:
- product-pages.md restructure also resolved a §5.4 numbering
collision introduced by Phase 1 (Comparison subsection
overwrote the existing Tone-and-framing subsection).
- api-endpoints.md §11 rename clarifies rendered-doc vs
schema-design split.
- ticket-impl-plan Step 1.5 split (PENDING/OMIT promoted from
aside to gate).
- clarification-steps.md §4.1 subsection (verbose
enum-disambiguation example separated from the bullet list).
- 5 pre-existing dangling LESSONS citations in
humanize-review/SKILL.md (from the 2026-04-27 consolidation)
cleaned up.
Process rules:
- RULES §4.4 added: archive verification — every consolidation
archival pass must grep all AI infra (RULES, skills, style
guides, cheatsheets, how-to, CLAUDE.md, AGENTS.md, ai/agent.md)
for citations to entries being removed; every hit must be
resolved before deletion. The Amendment Log is the one
acceptable place for historical references. Codifies the
Phase 6 cross-reference check that the 2026-05-24 consolidation
skipped.
- RULES §3.2 added: "Non-public identifiers — placeholders only"
— committed AI infra must NOT contain staging hostnames, IPs,
CF Access AUDs, account IDs, API key prefixes, HMAC signatures,
nonces, tokens, or any operational identifier tied to a
specific environment / account / person. Use <staging-host>,
<source-ip>, <aud-id>, YOUR_API_KEY, etc. Triggered by user
flag during the leak-scrub pass below — pattern was chronic
across worked-example LESSONS / methodology / cheatsheets.
Security cleanup (user-flagged):
- The new empirical-probe-methodology.md §4 Source line and the
cheatsheets/validation.md Live-API probe troubleshooting
section both leaked the staging hostname. Both replaced with
"the staging host (URL held by the user — never committed)"
placeholder. Same identifier was originally present in the
now-archived LESSONS 2026-04-29 entries; archival removes it
from current docs, and the new §3.2 rule prevents recurrence.
M3 cleanup (KEEP set 5 → 3):
- Cloudflare-Access edge-diagnostic content promoted to
ai/cheatsheets/validation.md as a new Live-API probe
troubleshooting subsection; LESSONS entry archived.
- 2026-04-14 Linter Note-blocks LESSONS entry dropped — the
underlying tool-interaction defect is already tracked by
the tracked-lessons.json "File has been modified since read"
row; page-specific operational detail was environmental.
Kept (3 meta-rules under observation):
- 2026-05-22 First-pass-correct rate
- 2026-05-22 Memory/RULES/LESSONS insufficient for tool-interaction
- 2026-05-22 New project skills multiply routing failure surface
whitebit-robot
added a commit
that referenced
this pull request
May 28, 2026
Two-phase landing on top of f7ba1ab (2026-05-22 retro):
Phase 1 — Learning-consolidator deep run (2026-05-24)
Reduces ai/LESSONS.md from 78 entries (~510 lines) to 3 entries
(~75 lines). 42 archived, 18 promoted into RULES / skills / style
guides, 5 → 3 kept after self-review.
Promotions:
- RULES §3.2: MDX-comment-syntax rule ({/* */}; HTML comments
silently break Mintlify parsing).
- RULES §2.2: `concept` added to commit scope list; mirrored in
write-commit-message/SKILL.md.
- skill-creator Phase 5: registration step split into three
numbered sub-steps + `grep -l` verification command.
- ticket-analysis: peer-evidence pass for new endpoints joining
an established family (collapses BLOCKER SME questions);
enum-identifier disambiguation §4.1 subsection; discovery
sweep before CREATE classification.
- ticket-impl-plan: PENDING-vs-OMIT user decision promoted from
aside to Step 1.5 gate.
- dev-ticket-pipeline + ticket-analysis Step 1 + ticket-impl-plan
Step 1: multi-ticket suffixed-input-file detection.
- humanize-review SKILL.md: mandatory per-task checks #5
(source-page terminology + dimension) and #6 (section-minimum
floor for Family 1.x deletions). ai-voice-catalog Family 6.1
verification gate parallel to 6.2.
- base.md §3.2.5: primary vs secondary pronoun enforcement
levels. §5.2.7: -ing compound noun exception ("Error handling"
accepted; verb-phrase gerunds still rejected).
- product-pages.md: full §5–§9 restructure — Comparison pages
promoted to new top-level §6 with three subsections; Quickstart
§6 → §7; Shared rules §7 → §8; Checklists §8 → §9.
- api-endpoints.md §11: renamed to "Response documentation and
schema design" with intro distinguishing rendered-doc rules
(§11.1–4) from spec-design rules (§11.5–7). §11.5 cancel/ack
schema-reuse prohibition. §11.6 per-endpoint schema variance.
§11.7 shared-description-edit verification. §13.1 spec-driven
page channel for pagination.
Phase 2 — Adversarial self-review (2026-05-25)
Surfaced three critical cross-reference defects, five structural
improvements, two process rules, and one user-flagged security leak.
Critical fixes (cross-reference dangling pointers from Phase 1):
- New ai/skills/dev-ticket-pipeline/references/empirical-probe-
methodology.md captures the four V4 probe patterns
(live signed probing + signing pattern; two-variant
write-then-read; three-phase state-toggle; Cloudflare-Access
diagnostic). dev-ticket-pipeline empirical-probe paragraph
rewritten to point at the new reference instead of the three
archived 2026-04-29 LESSONS entries.
- ai/RULES.md §2.4 Source line rewritten to point at the
methodology reference + Amendment Log row, not the archived
LESSONS entry.
- ai/skills/answer-partner-questions/SKILL.md step 5 gained an
explicit 403-fallback paragraph — Zendesk blocks WebFetch and
curl regardless of User-Agent; do not retry with UAs or pivot
to competitor docs; ask user to paste the article body into
ai/inputs/<feature>-help-article.md. The ADL release resolved
9 of 25 SME questions this way.
Structural improvements:
- product-pages.md restructure also resolved a §5.4 numbering
collision introduced by Phase 1 (Comparison subsection
overwrote the existing Tone-and-framing subsection).
- api-endpoints.md §11 rename clarifies rendered-doc vs
schema-design split.
- ticket-impl-plan Step 1.5 split (PENDING/OMIT promoted from
aside to gate).
- clarification-steps.md §4.1 subsection (verbose
enum-disambiguation example separated from the bullet list).
- 5 pre-existing dangling LESSONS citations in
humanize-review/SKILL.md (from the 2026-04-27 consolidation)
cleaned up.
Process rules:
- RULES §4.4 added: archive verification — every consolidation
archival pass must grep all AI infra (RULES, skills, style
guides, cheatsheets, how-to, CLAUDE.md, AGENTS.md, ai/agent.md)
for citations to entries being removed; every hit must be
resolved before deletion. The Amendment Log is the one
acceptable place for historical references. Codifies the
Phase 6 cross-reference check that the 2026-05-24 consolidation
skipped.
- RULES §3.2 added: "Non-public identifiers — placeholders only"
— committed AI infra must NOT contain staging hostnames, IPs,
CF Access AUDs, account IDs, API key prefixes, HMAC signatures,
nonces, tokens, or any operational identifier tied to a
specific environment / account / person. Use <staging-host>,
<source-ip>, <aud-id>, YOUR_API_KEY, etc. Triggered by user
flag during the leak-scrub pass below — pattern was chronic
across worked-example LESSONS / methodology / cheatsheets.
Security cleanup (user-flagged):
- The new empirical-probe-methodology.md §4 Source line and the
cheatsheets/validation.md Live-API probe troubleshooting
section both leaked the staging hostname. Both replaced with
"the staging host (URL held by the user — never committed)"
placeholder. Same identifier was originally present in the
now-archived LESSONS 2026-04-29 entries; archival removes it
from current docs, and the new §3.2 rule prevents recurrence.
M3 cleanup (KEEP set 5 → 3):
- Cloudflare-Access edge-diagnostic content promoted to
ai/cheatsheets/validation.md as a new Live-API probe
troubleshooting subsection; LESSONS entry archived.
- 2026-04-14 Linter Note-blocks LESSONS entry dropped — the
underlying tool-interaction defect is already tracked by
the tracked-lessons.json "File has been modified since read"
row; page-specific operational detail was environmental.
Kept (3 meta-rules under observation):
- 2026-05-22 First-pass-correct rate
- 2026-05-22 Memory/RULES/LESSONS insufficient for tool-interaction
- 2026-05-22 New project skills multiply routing failure surface
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
Fixes spelling errors, grammar mistakes, and formatting issues found across 8 documentation files after scanning all 198 MDX pages.
Changes
platform/webhook.mdx
platform/colocation.mdx
platform/oauth/overview.mdx
Titles with missing space (4 files)
private/http-trade-v1/overview.mdx