-
Notifications
You must be signed in to change notification settings - Fork 73
Overhaul Mini Apps IA and scaffold new docs | WIP #207
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -413,6 +413,117 @@ | |
} | ||
] | ||
}, | ||
{ | ||
"tab": "Mini Apps", | ||
"groups": [ | ||
{ | ||
"group": "Introduction", | ||
"pages": ["mini-apps/overview"] | ||
}, | ||
{ | ||
"group": "Quickstart", | ||
"pages": [ | ||
{ | ||
"group": "New Apps", | ||
"pages": [ | ||
"mini-apps/quickstart/build-a-mini-app/install", | ||
"mini-apps/quickstart/build-a-mini-app/deploy", | ||
"mini-apps/quickstart/build-a-mini-app/create-manifest", | ||
"mini-apps/quickstart/build-a-mini-app/feature-tour" | ||
] | ||
}, | ||
{ | ||
"group": "Existing Apps", | ||
"pages": [ | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/install", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/add-minikit", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/configure-environment", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/manifest-cli", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/create-farcaster-json", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/add-frame-metadata", | ||
"mini-apps/quickstart/turn-your-app-into-a-mini-app/test-and-deploy" | ||
] | ||
}, | ||
"mini-apps/quickstart/launch-guide" | ||
] | ||
}, | ||
{ | ||
"group": "Get Featured", | ||
"pages": [ | ||
"mini-apps/quality-and-publishing/overview", | ||
"mini-apps/quality-and-publishing/quality-bar", | ||
"mini-apps/quality-and-publishing/submission-guidelines" | ||
] | ||
}, | ||
{ | ||
"group": "Design & UX Standards", | ||
"pages": [ | ||
"mini-apps/design-ux/design-patterns-for-mini-apps", | ||
"mini-apps/design-ux/onchainkit-usage", | ||
"mini-apps/design-ux/ui-patterns", | ||
"mini-apps/design-ux/language-and-tone" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. would remove for now unless DevRel has already made the content for it There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Definitely. This section is just placeholder for the docs you and your team are looking to add |
||
] | ||
}, | ||
{ | ||
"group": "Growth Playbook", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. love this section! |
||
"pages": [ | ||
"mini-apps/growth/optimized-onboarding", | ||
"mini-apps/growth/build-viral-mini-apps", | ||
"mini-apps/growth/base-build-analytics", | ||
"mini-apps/growth/implementing-other-analytics", | ||
"mini-apps/growth/event-schema" | ||
] | ||
}, | ||
{ | ||
"group": "Mini App Features", | ||
"pages": [ | ||
"mini-apps/features/overview", | ||
"mini-apps/features/manifest", | ||
"mini-apps/features/authentication", | ||
"mini-apps/features/embeds-and-previews", | ||
"mini-apps/features/search-and-discovery", | ||
"mini-apps/features/sharing-and-social-graph", | ||
"mini-apps/features/notifications", | ||
"mini-apps/features/open-close-and-external-links", | ||
"mini-apps/features/webhooks" | ||
] | ||
}, | ||
{ | ||
"group": "Troubleshooting", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. love!! |
||
"pages": [ | ||
"mini-apps/troubleshooting/common-issues", | ||
"mini-apps/troubleshooting/error-handling", | ||
"mini-apps/troubleshooting/base-app-compatibility" | ||
] | ||
}, | ||
{ | ||
"group": "Technical Reference", | ||
"pages": [ | ||
{ | ||
"group": "MiniKit", | ||
"pages": [ | ||
"mini-apps/technical-reference/minikit/provider-and-initialization", | ||
{ | ||
"group": "Hooks", | ||
"pages": [ | ||
"mini-apps/technical-reference/minikit/hooks/useMiniKit", | ||
"mini-apps/technical-reference/minikit/hooks/useAddFrame", | ||
"mini-apps/technical-reference/minikit/hooks/useNotification", | ||
"mini-apps/technical-reference/minikit/hooks/useOpenUrl", | ||
"mini-apps/technical-reference/minikit/hooks/useClose", | ||
"mini-apps/technical-reference/minikit/hooks/usePrimaryButton", | ||
"mini-apps/technical-reference/minikit/hooks/useViewProfile", | ||
"mini-apps/technical-reference/minikit/hooks/useComposeCast", | ||
"mini-apps/technical-reference/minikit/hooks/useViewCast", | ||
"mini-apps/technical-reference/minikit/hooks/useAuthenticate" | ||
] | ||
} | ||
] | ||
} | ||
] | ||
} | ||
] | ||
}, | ||
{ | ||
"tab": "OnchainKit", | ||
"groups": [ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Design Patterns for Mini Apps | ||
description: Principles and patterns to build social, repeat-use experiences | ||
--- | ||
|
||
Importing core content from Thinking Social. | ||
|
||
<Note> | ||
This page will summarize design principles and link to the detailed guide below. | ||
</Note> | ||
|
||
<Card title="Build Viral Mini Apps (detailed guide)" icon="users" href="/base-app/build-with-minikit/thinking-social" /> | ||
|
||
TODO: Add condensed patterns and examples tailored to Mini Apps (identity, co‑creation, rituals). | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Language and Tone | ||
description: Copy guidelines for concise, friendly Mini App experiences | ||
--- | ||
|
||
TODO: Provide copy patterns for onboarding, errors, and social sharing within Mini Apps. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: OnchainKit Usage in Mini Apps | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: I think it's enough to say "OnchainKit" / drop "Mini Apps" from most titles to make everything easier to skim. The pages are under "Mini Apps" tab so it's implied that they're for mini apps. |
||
description: How to leverage OnchainKit components and MiniKit together | ||
--- | ||
|
||
TODO: Document recommended OnchainKit components for Mini Apps, integration tips, and examples. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: UI Patterns for Mini Apps | ||
description: Compact, touch-first interfaces that fit Mini App contexts | ||
--- | ||
|
||
TODO: Safe area insets, primary button usage, compact layouts, input ergonomics, and accessibility considerations. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Authentication | ||
description: Let users start fast and ask for a wallet only when needed | ||
--- | ||
|
||
## Authentication guidance from Base App | ||
|
||
<Warning> | ||
Save authentication that requires an interaction for interactions that require it (e.g., buying something, viewing personalized pages). | ||
</Warning> | ||
|
||
Supported approaches: | ||
|
||
<Tabs> | ||
<Tab title="Sign In with Farcaster / Quick Auth"> | ||
Base App supports SIWF in‑app, enabling social identity without leaving the app. Quick Auth can issue a JWT to persist session state. | ||
</Tab> | ||
|
||
<Tab title="Wallet Auth"> | ||
Base App provides an in‑app smart wallet. Use wallet auth for a persisted session when necessary, but avoid gating initial exploration behind connect. | ||
</Tab> | ||
|
||
<Tab title="Context Data"> | ||
All hosts return context data (including user). Use it for analytics or lightweight session hints, but do not treat as primary auth. | ||
</Tab> | ||
</Tabs> | ||
|
||
Best practices: | ||
|
||
- Gate wallet only at the point of onchain action | ||
- Prefer SIWF/Quick Auth for low‑friction identity | ||
- Use context for analytics; avoid using it as primary auth | ||
|
||
Further reading: | ||
|
||
<CardGroup cols={2}> | ||
<Card title="useAuthenticate" icon="book-open" href="/mini-apps/technical-reference/minikit/hooks/useAuthenticate" /> | ||
<Card title="Provider & Initialization" icon="cog" href="/mini-apps/technical-reference/minikit/provider-and-initialization" /> | ||
</CardGroup> | ||
|
||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let’s make sure there’s no duplicate content between "quality-bar" and "submission-guidelines". We can keep things clearer by having one distinct checklist for each purpose e.g. one for Launch, one for Submission—this way, it’s easier for builders to follow and for our team to iterate on together.