Skip to content

docs: port the whisk docs to mintlify for the 0.3 release - #6

Merged
Signor1 merged 1 commit into
mainfrom
docs/mintlify-port
Oct 28, 2026
Merged

Signor1 merged 1 commit into
mainfrom
docs/mintlify-port

Conversation

@Signor1

@Signor1 Signor1 commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Refs #1 and #2. The Mintlify site for docs.usewhisk.xyz, covering the published @usewhisk/react and @usewhisk/core 0.3.x and @usewhisk/cctp 0.1.x.

What is in it

55 pages in three tabs.

  • Docs:

    Group Pages
    Get started landing, quickstart, installation, wallets, chains, RPC
    Concepts how it works, amounts and units, quotes and fees, recovery, recipients, errors, fund safety
    Widget provider, WhiskSend, receipt, resume list, connect modal, primitives
    Theming overview, tokens, Tailwind, fonts
    Hooks 5 pages
    Headless core engine, React headless, server, Vue
    Payment flows checkout, receipts, refunds, metadata
    Recipes one per example app, 5 pages
  • Reference: every export of @usewhisk/react, @usewhisk/core and @usewhisk/cctp.

    • Two coverage checks: 252 of 252 react and core exports are named on the reference pages, and every cctp export is too.
    • The error catalogue gives every code, its class, when it happens, whether funds have moved, and what to do.
    • The table of all 56 chains is generated from the registry by scripts/gen-chains-table.mjs.
    • cctp had no docs before this.
  • Migration:

    • New 0.2 to 0.3 guide: the @wagmi/core 2.17 floor, the merchant fee after the burn and customFee, supportsAtomicBatch and atomic for custom EVM adapters, getTrustline for custom Stellar adapters, the destination checks before the burn, and the Starknet recipient refusals with allowUndeployedRecipient.
    • The full 0.1 to 0.2 guide, with all 16 breaking changes. The port also fixes three errors in the original page:
    • the quote errors are importable from react;
    • only quote throws NetworkMismatchError;
    • same_chain is added to the ROUTE_UNAVAILABLE reasons.

The site follows the ledger direction in the platform ADR: light only with the toggle hidden, Whisk Cobalt #2b3cff on paper #fbfaf7, Geist, and the willow theme.

How it was checked

After merge (maintainer)

  1. In Mintlify, create the project from this repo: install the Mintlify GitHub app on usewhisk/docs, branch main.
  2. Add the custom domain docs.usewhisk.xyz in Mintlify, then the CNAME it gives you at your DNS provider.
  3. Once the site serves, apps/docs can be deleted from usewhisk/whisk (Phase 1 ADR Decision 9.3), and Move apps/docs content out of the whisk repo #2 closes.

@Signor1
Signor1 merged commit 7745f1c into main Oct 28, 2026
4 checks passed
@Signor1
Signor1 deleted the docs/mintlify-port branch October 28, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant