Skip to content

Commit 6fe43e1

Browse files
authored
Migrate MiniKit technical reference to OnchainKit (#510)
1 parent 7b7f198 commit 6fe43e1

22 files changed

+93
-617
lines changed

docs/docs.json

Lines changed: 72 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -486,33 +486,6 @@
486486
"mini-apps/troubleshooting/base-app-compatibility"
487487
]
488488
},
489-
{
490-
"group": "Technical Reference",
491-
"pages": [
492-
{
493-
"group": "MiniKit",
494-
"pages": [
495-
"mini-apps/technical-reference/minikit/overview",
496-
"mini-apps/technical-reference/minikit/provider-and-initialization",
497-
{
498-
"group": "Hooks",
499-
"pages": [
500-
"mini-apps/technical-reference/minikit/hooks/useMiniKit",
501-
"mini-apps/technical-reference/minikit/hooks/useOpenUrl",
502-
"mini-apps/technical-reference/minikit/hooks/useClose",
503-
"mini-apps/technical-reference/minikit/hooks/usePrimaryButton",
504-
"mini-apps/technical-reference/minikit/hooks/useViewProfile",
505-
"mini-apps/technical-reference/minikit/hooks/useComposeCast",
506-
"mini-apps/technical-reference/minikit/hooks/useViewCast",
507-
"mini-apps/technical-reference/minikit/hooks/useAuthenticate",
508-
"mini-apps/technical-reference/minikit/hooks/useAddFrame",
509-
"mini-apps/technical-reference/minikit/hooks/useNotification"
510-
]
511-
}
512-
]
513-
}
514-
]
515-
},
516489
{
517490
"group": "Resources",
518491
"pages": [
@@ -585,6 +558,28 @@
585558
"group": "Mint",
586559
"pages": ["onchainkit/latest/components/mint/nft-card", "onchainkit/latest/components/mint/nft-mint-card"]
587560
},
561+
{
562+
"group": "MiniKit",
563+
"pages": [
564+
"onchainkit/latest/components/minikit/overview",
565+
"onchainkit/latest/components/minikit/provider-and-initialization",
566+
{
567+
"group": "Hooks",
568+
"pages": [
569+
"onchainkit/latest/components/minikit/hooks/useMiniKit",
570+
"onchainkit/latest/components/minikit/hooks/useOpenUrl",
571+
"onchainkit/latest/components/minikit/hooks/useClose",
572+
"onchainkit/latest/components/minikit/hooks/usePrimaryButton",
573+
"onchainkit/latest/components/minikit/hooks/useViewProfile",
574+
"onchainkit/latest/components/minikit/hooks/useComposeCast",
575+
"onchainkit/latest/components/minikit/hooks/useViewCast",
576+
"onchainkit/latest/components/minikit/hooks/useAuthenticate",
577+
"onchainkit/latest/components/minikit/hooks/useAddFrame",
578+
"onchainkit/latest/components/minikit/hooks/useNotification"
579+
]
580+
}
581+
]
582+
},
588583
{
589584
"group": "Signature",
590585
"pages": ["onchainkit/latest/components/signature/signature"]
@@ -622,14 +617,6 @@
622617
{
623618
"group": "Connected",
624619
"pages": ["onchainkit/latest/components/connected/connected"]
625-
},
626-
{
627-
"group": "MiniKit",
628-
"pages": [
629-
"onchainkit/latest/components/minikit/autoconnect",
630-
"onchainkit/latest/components/minikit/if-in-miniapp",
631-
"onchainkit/latest/components/minikit/safe-area"
632-
]
633620
}
634621
]
635622
},
@@ -2664,11 +2651,11 @@
26642651
},
26652652
{
26662653
"source": "/base-app/miniapps/overview",
2667-
"destination": "/mini-apps/technical-reference/minikit/overview"
2654+
"destination": "/onchainkit/latest/components/minikit/overview"
26682655
},
26692656
{
26702657
"source": "/base-app/build-with-minikit/overview",
2671-
"destination": "/mini-apps/technical-reference/minikit/overview"
2658+
"destination": "/onchainkit/latest/components/minikit/overview"
26722659
},
26732660
{
26742661
"source": "/base-app/miniapps/existing-app-integration",
@@ -2781,6 +2768,54 @@
27812768
{
27822769
"source": "/mini-apps/quickstart/launch-checklist",
27832770
"destination": "/mini-apps/quickstart/build-checklist"
2771+
},
2772+
{
2773+
"source": "/mini-apps/technical-reference/minikit/overview",
2774+
"destination": "/onchainkit/latest/components/minikit/overview"
2775+
},
2776+
{
2777+
"source": "/mini-apps/technical-reference/minikit/provider-and-initialization",
2778+
"destination": "/onchainkit/latest/components/minikit/provider-and-initialization"
2779+
},
2780+
{
2781+
"source": "/mini-apps/technical-reference/minikit/hooks/useMiniKit",
2782+
"destination": "/onchainkit/latest/components/minikit/hooks/useMiniKit"
2783+
},
2784+
{
2785+
"source": "/mini-apps/technical-reference/minikit/hooks/useOpenUrl",
2786+
"destination": "/onchainkit/latest/components/minikit/hooks/useOpenUrl"
2787+
},
2788+
{
2789+
"source": "/mini-apps/technical-reference/minikit/hooks/useClose",
2790+
"destination": "/onchainkit/latest/components/minikit/hooks/useClose"
2791+
},
2792+
{
2793+
"source": "/mini-apps/technical-reference/minikit/hooks/usePrimaryButton",
2794+
"destination": "/onchainkit/latest/components/minikit/hooks/usePrimaryButton"
2795+
},
2796+
{
2797+
"source": "/mini-apps/technical-reference/minikit/hooks/useViewProfile",
2798+
"destination": "/onchainkit/latest/components/minikit/hooks/useViewProfile"
2799+
},
2800+
{
2801+
"source": "/mini-apps/technical-reference/minikit/hooks/useComposeCast",
2802+
"destination": "/onchainkit/latest/components/minikit/hooks/useComposeCast"
2803+
},
2804+
{
2805+
"source": "/mini-apps/technical-reference/minikit/hooks/useViewCast",
2806+
"destination": "/onchainkit/latest/components/minikit/hooks/useViewCast"
2807+
},
2808+
{
2809+
"source": "/mini-apps/technical-reference/minikit/hooks/useAuthenticate",
2810+
"destination": "/onchainkit/latest/components/minikit/hooks/useAuthenticate"
2811+
},
2812+
{
2813+
"source": "/mini-apps/technical-reference/minikit/hooks/useAddFrame",
2814+
"destination": "/onchainkit/latest/components/minikit/hooks/useAddFrame"
2815+
},
2816+
{
2817+
"source": "/mini-apps/technical-reference/minikit/hooks/useNotification",
2818+
"destination": "/onchainkit/latest/components/minikit/hooks/useNotification"
27842819
}
27852820
],
27862821
"integrations": {

docs/mini-apps/core-concepts/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Your mini app's domain
149149
150150
151151
<CardGroup cols={2}>
152-
<Card title="useAuthenticate" href="/mini-apps/technical-reference/minikit/hooks/useAuthenticate">
152+
<Card title="useAuthenticate" href="/onchainkit/latest/components/minikit/hooks/useAuthenticate">
153153
use Minikit's useAuthenticate hook to authenticate users.
154154
</Card>
155155
<Card title="Context" href="/mini-apps/core-concepts/context">

docs/mini-apps/core-concepts/navigation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ composeCast({
101101
</Tab>
102102
<Tab title="MiniKit">
103103

104-
Use [`useOpenUrl()`](/mini-apps/technical-reference/minikit/hooks/useOpenUrl) to safely open external websites in the client's in-app browser:
104+
Use [`useOpenUrl()`](/onchainkit/latest/components/minikit/hooks/useOpenUrl) to safely open external websites in the client's in-app browser:
105105

106106
```tsx components/ExternalLinks.tsx highlight={8 -10}
107107
import { useOpenUrl } from '@coinbase/onchainkit/minikit';
@@ -153,7 +153,7 @@ composeCast({
153153
```
154154
</Tab>
155155
<Tab title="MiniKit">
156-
Use [`useComposeCast()`](/mini-apps/technical-reference/minikit/hooks/useComposeCast) to open the native composer with prefilled content:
156+
Use [`useComposeCast()`](/onchainkit/latest/components/minikit/hooks/useComposeCast) to open the native composer with prefilled content:
157157
```tsx components/ShareCast.tsx highlight={8-13}
158158
import { useComposeCast } from '@coinbase/onchainkit/minikit';
159159

@@ -198,7 +198,7 @@ composeCast({
198198
</Tab>
199199
<Tab title="MiniKit">
200200

201-
Use [`useViewCast()`](/mini-apps/technical-reference/minikit/hooks/useViewCast) to open a specific cast by its hash:
201+
Use [`useViewCast()`](/onchainkit/latest/components/minikit/hooks/useViewCast) to open a specific cast by its hash:
202202
```tsx components/ViewCastButton.tsx highlight={4,7-9}
203203
import { useViewCast } from '@coinbase/onchainkit/minikit';
204204

docs/mini-apps/growth/optimize-onboarding.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Deliver value instantly and avoid blocking actions.
2020
<Steps>
2121
<Step title="First render">
2222
- Show immediate value (demo content, sample state, or read-only mode)
23-
- Personalize instantly with [`context`](/mini-apps/technical-reference/minikit/provider-and-initialization) of the user's profile to instantly personalize
23+
- Personalize instantly with [`context`](/onchainkit/latest/components/minikit/provider-and-initialization) of the user's profile to instantly personalize
2424
- Display one clear CTA that leads to a meaningful action (e.g. "Post a message", "Buy a token", "Follow a user")
2525
</Step>
2626

@@ -108,8 +108,8 @@ Learn how to implement them with [SDK actions](/mini-apps/features/links).
108108

109109
<CardGroup cols={3}>
110110
<Card title="Sharing & Social Graph" icon="share" href="/mini-apps/features/sharing-and-social-graph" />
111-
<Card title="Provider & Initialization" icon="cog" href="/mini-apps/technical-reference/minikit/provider-and-initialization" />
112-
<Card title="useAuthenticate" icon="book-open" href="/mini-apps/technical-reference/minikit/hooks/useAuthenticate" />
111+
<Card title="Provider & Initialization" icon="cog" href="/onchainkit/latest/components/minikit/provider-and-initialization" />
112+
<Card title="useAuthenticate" icon="book-open" href="/onchainkit/latest/components/minikit/hooks/useAuthenticate" />
113113
</CardGroup>
114114

115115

docs/mini-apps/llms-full.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ export function Providers(props: { children: React.ReactNode }) {
5959
- [Base App Compatibility](https://docs.base.org/mini-apps/troubleshooting/base-app-compatibility.md) — Client behavior
6060

6161
### Technical Reference
62-
- [MiniKit Overview](https://docs.base.org/mini-apps/technical-reference/minikit/overview.md) — Overview
63-
- [Provider & Initialization](https://docs.base.org/mini-apps/technical-reference/minikit/provider-and-initialization.md) — Provider
64-
- [Hooks](https://docs.base.org/mini-apps/technical-reference/minikit/hooks/useMiniKit.md) — Hooks
62+
- [MiniKit Overview](https://docs.base.org/onchainkit/latest/components/minikit/overview.md) — Overview
63+
- [Provider & Initialization](https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md) — Provider
64+
- [Hooks](https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md) — Hooks
6565

6666

6767
## Quickstart (excerpts)
@@ -128,7 +128,7 @@ Modes summary (from Authentication):
128128
Hook reference:
129129

130130
- useAuthenticate — Returns verified user from SIWF or wallet auth. Use alongside `useMiniKit` context.
131-
- Source: `https://docs.base.org/mini-apps/technical-reference/minikit/hooks/useAuthenticate.md`
131+
- Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useAuthenticate.md`
132132

133133
Example (hook usage):
134134

@@ -171,9 +171,9 @@ Prompt timing guidelines:
171171
## API and Schemas (pruned)
172172

173173
- MiniKit Provider and initialization props
174-
- Source: `https://docs.base.org/mini-apps/technical-reference/minikit/provider-and-initialization.md`
174+
- Source: `https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md`
175175
- `useMiniKit` hook: access frame context, user, and client capabilities
176-
- Source: `https://docs.base.org/mini-apps/technical-reference/minikit/hooks/useMiniKit.md`
176+
- Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md`
177177

178178
Example manifest fields (conceptual):
179179

@@ -221,7 +221,7 @@ Example: Wire providers for OnchainKit + MiniKit
221221

222222
Sources:
223223
- `https://docs.base.org/mini-apps/design-ux/onchainkit.md`
224-
- `https://docs.base.org/mini-apps/technical-reference/minikit/provider-and-initialization.md`
224+
- `https://docs.base.org/onchainkit/latest/components/minikit/provider-and-initialization.md`
225225

226226
```tsx
227227
import { OnchainKitProvider } from '@coinbase/onchainkit'
@@ -238,7 +238,7 @@ export function Providers(props: { children: React.ReactNode }) {
238238

239239
Example: Use `useMiniKit` to access client context
240240

241-
Source: `https://docs.base.org/mini-apps/technical-reference/minikit/hooks/useMiniKit.md`
241+
Source: `https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md`
242242

243243
```tsx
244244
import { useMiniKit } from '@coinbase/minikit'

docs/mini-apps/llms.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
- [Base App Compatibility](https://docs.base.org/mini-apps/troubleshooting/base-app-compatibility.md) — Base App client-specific behaviors for issues where an app works in the Farcaster client but not Base App
3030

3131
## Technical Reference
32-
- [MiniKit Overview](https://docs.base.org/mini-apps/technical-reference/minikit/overview.md) — Architecture, provider, CLI, and hooks
33-
- [Hooks: useMiniKit](https://docs.base.org/mini-apps/technical-reference/minikit/hooks/useMiniKit.md) — Access frame context and client features
32+
- [MiniKit Overview](https://docs.base.org/onchainkit/latest/components/minikit/overview.md) — Architecture, provider, CLI, and hooks
33+
- [Hooks: useMiniKit](https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md) — Access frame context and client features
3434

3535
## Optional
3636
- [Search & Discovery](https://docs.base.org/mini-apps/features/search-and-discovery.md) — Indexing and ranking signals in Base App

docs/mini-apps/technical-guides/sharing-and-social-graph.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Strategic sharing moments include: post‑achievement, post‑mint, after beatin
4242
Link users into casts and profiles directly from your app via MiniKit hooks.
4343

4444
<CardGroup cols={2}>
45-
<Card title="useViewCast" icon="book-open" href="/mini-apps/technical-reference/minikit/hooks/useViewCast" />
46-
<Card title="useViewProfile" icon="book-open" href="/mini-apps/technical-reference/minikit/hooks/useViewProfile" />
45+
<Card title="useViewCast" icon="book-open" href="/onchainkit/latest/components/minikit/hooks/useViewCast" />
46+
<Card title="useViewProfile" icon="book-open" href="/onchainkit/latest/components/minikit/hooks/useViewProfile" />
4747
</CardGroup>
4848

4949
## Best Practices

0 commit comments

Comments
 (0)