Fix 23 broken links in docs/ guides and references#2
Open
mintlify[bot] wants to merge 101 commits into
Open
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
DV-43: Added new docs according to provided documentaion
- Create api-reference/mining-pool/ directory with 12 stub pages - Pages reference operations in main_api_v4.yaml (11 private endpoints) and http-v4.yaml (pool overview public endpoint) - Fixes 404 errors and group rendering for all Mining Pool nav items
DV-16: update logo redirect to documentation home
DV-21: Openapi changed according to SDK validation
- Fix hash rate units from "H units"/"TH/s" to H/s across pool
overview and all private hashrate endpoints; add H/s descriptions
to currentHashRate and hashrate response fields
- Add sort order (DESC/newest first) to rewards; add time-window
constraints and default-behavior note to account and worker
hashrate endpoints; fix worker names to remove non-existent
pagination params
- Document BTC address types (P2PKH, P2SH, bech32), missing-address
validation error, 3-link max per account, and name format error
for watcher links
- Fix broken mining pool card links in market-data and account-wallet
overview pages; fix indentation in http-v4.yaml data properties
- Fix description style violations on payout-destination endpoints
(rule 5.1.2)
docs(api): apply SME answers to mining pool endpoints
…ld-example fix(api): update example of rewards field in mining pool rewards endp…
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
…-fields fix(api): add missing mining pool rewards fields
…-fields fix(api): typo
…-fields api(docs): change payoutDestination example in mining rewards response
Convert relative .md links to absolute Mintlify paths and replace CONTRIBUTING.md references with GitHub URLs since the file is excluded from Mintlify via .mintignore. Generated-By: mintlify-agent
whitebit-robot
added a commit
that referenced
this pull request
Apr 1, 2026
github workflow for mirroring was added;
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 23 broken links across 10 files in
docs/guides/anddocs/reference/.What was wrong
All internal links used relative
.mdpaths (e.g.,02-adding-descriptions.md,../reference/style-guide.md) which Mintlify's link checker cannot resolve. Additionally, 3 links pointed to../../CONTRIBUTING.mdwhich is excluded from Mintlify via.mintignore.Fixes applied
docs/guides/01-adding-parameters.md02-adding-descriptions.md,03-parameter-exceptions.md/docs/guides/...)docs/guides/02-adding-descriptions.md04-documenting-errors.md,01-adding-parameters.mddocs/guides/03-parameter-exceptions.md01-adding-parameters.md,04-documenting-errors.mddocs/guides/04-documenting-errors.md02-adding-descriptions.mddocs/guides/05-adding-new-endpoints.md01-adding-parameters.md(x2),02-adding-descriptions.md,04-documenting-errors.mddocs/reference/common-pitfalls.mdvalidation.md,../../CONTRIBUTING.mddocs/reference/file-structure.mdquick-reference.mddocs/reference/quick-reference.mdstyle-guide.md,file-structure.md,validation.md,common-pitfalls.mddocs/reference/style-guide.mdquick-reference.md,common-pitfalls.md,../../CONTRIBUTING.mddocs/reference/validation.md../../CONTRIBUTING.md,common-pitfalls.mdLink type conversions
02-adding-descriptions.md) -> absolute Mintlify path (/docs/guides/02-adding-descriptions)../reference/style-guide.md) -> absolute Mintlify path (/docs/reference/style-guide).mintignored) -> GitHub URL (https://github.com/whitebit-exchange/docs/blob/main/CONTRIBUTING.md)Validation
Both
mint validateandmint broken-linkspass with zero errors.