Fix grammar and formatting in webhook and OAuth docs#14
Open
mintlify[bot] wants to merge 137 commits intomainfrom
Open
Fix grammar and formatting in webhook and OAuth docs#14mintlify[bot] wants to merge 137 commits intomainfrom
mintlify[bot] wants to merge 137 commits intomainfrom
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
- 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
fix(api): restore mining pool rewards changes reverted by PR #49
Add integration-check, task-execution, and task-completion-review skills. These wrap the logic from ai/prompts/ into the skills architecture, enabling orchestrator skills (dev-ticket-pipeline, doc-review-pipeline) to invoke sub-skills instead of referencing prompt files directly.
…mpt migration Absorb 7 prompt files into 13 new references/ files across ticket-analysis, ticket-impl-plan, doc-style-review, doc-review-plan, generate-docs-from-spec, and write-commit-message. Update all SKILL.md steps to reference the new files instead of ai/prompts/. Remove stale cleanup.md note from cleanup-after-pipeline.
…3 of prompt migration Replace ai/prompts/ references in dev-ticket-pipeline, doc-review-pipeline, task-self-review, plan-review, and learning-consolidator with direct skill invocations. task-execution and task-completion-review are now called as skills instead of prompts in Phase 5 and Phase 6 of both pipelines.
- Add spec↔doc consistency check to validate.mjs (--consistency): warns when an OpenAPI spec is changed without updating its MDX pages, and vice versa - Add Husky + lint-staged pre-commit hooks: MDX→validate, nav→ validate, openapi→Redocly lint, asyncapi→AsyncAPI validate, always→consistency check - Add validate.yml CI workflow: blocks PRs on validate.mjs failure - Update mirror.yml to strip .github/ and .husky/ from public repo - Add PR checklist template - Update RULES.md §2.3 and CLAUDE.md to reflect new automation
Adds a mandatory Technical Writer review skill that runs as Phase 0 of doc-review-pipeline before the formal style review. Designed for engineer-written documentation — auto-detects document type via Diataxis framework, runs a five-tier staged review, and checks eight engineer-specific anti-patterns. Produces a structured findings report with user-impact arguments; gates pipeline on REVISE FIRST verdict. - References: review-tiers.md, engineer-antipatterns.md, output-format.md - Removed disable-model-invocation from skill-creator and skill-reviewer to allow pipeline invocability - Registered as Automatic in CLAUDE.md; 3 lessons added to LESSONS.md
Tooling/ai skills
…gReward Move payoutAddress and payoutTime adjacent to payoutDestination and payoutTransactionHash for consistent field grouping. Add null condition documentation to payoutTime matching the other payout fields.
…s into feature/CEX-5472
CEX-5472: add payoutAddress & payoutTime to /api/v4/mining/rewards
Stage to main
Generated-By: mintlify-agent
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
Fixed grammar errors, formatting issues, and a stray quote in two documentation files:
platform/webhook.mdx
platform/oauth/overview.mdx
####to###for "Trading Bots & Algorithmic Trading"