Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .cursor/rules/content-guide.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,17 @@ description: "Concise description explaining page purpose and value"
- Use **RequestExample/ResponseExample** specifically for API endpoint documentation
- Use **ParamField** for API parameters, **ResponseField** for API responses
- Use **Expandable** for nested object properties or hierarchical information

## Base App Spelling Rules

- Always write as **"the Base app"** with lowercase "app" in mid-sentence usage
- Write as **"The Base App"** with both words capitalized only at the start of sentences
- Never use **"Base App"** as a standalone term without the article "the" or "The"
- The word "App" is capitalized only when "The" is also capitalized (sentence-initial position)

## Find and Replace Pattern

- Find **"Base App"** without preceding article → Replace with **"the Base app"**
- Find **"the Base App"** in mid-sentence → Replace with **"the Base app"**
- Find **"The Base app"** at sentence start → Replace with **"The Base App"**
- Find **"the Base app"** after periods, colons, or sentence-ending punctuation → Replace with **"The Base App"**
15 changes: 9 additions & 6 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -453,8 +453,6 @@
{
"group": "Technical Guides",
"pages": [
"mini-apps/technical-guides/search-and-discovery",
"mini-apps/technical-guides/sharing-and-social-graph",
"mini-apps/technical-guides/sign-manifest",
"mini-apps/technical-guides/neynar-notifications"
]
Expand Down Expand Up @@ -482,7 +480,8 @@
"group": "Troubleshooting",
"pages": [
"mini-apps/troubleshooting/common-issues",
"mini-apps/troubleshooting/base-app-compatibility"
"mini-apps/troubleshooting/base-app-compatibility",
"mini-apps/troubleshooting/how-search-works"
]
},
{
Expand Down Expand Up @@ -1492,6 +1491,10 @@
]
},
"redirects": [
{
"source": "/mini-apps/technical-guides/search-discovery",
"destination": "/mini-apps/troubleshooting/how-search-works"
},
{
"source": "/mini-apps/overview",
"destination": "/mini-apps/quickstart/create-new-miniapp"
Expand All @@ -1518,7 +1521,7 @@
},
{
"source": "/mini-apps/features/search-and-discovery",
"destination": "/mini-apps/technical-guides/search-and-discovery"
"destination": "/mini-apps/troubleshooting/how-search-works"
},
{
"source": "/mini-apps/features/sharing-and-social-graph",
Expand Down Expand Up @@ -2690,11 +2693,11 @@
},
{
"source": "/base-app/miniapps/search-and-discovery",
"destination": "/mini-apps/technical-guides/search-and-discovery"
"destination": "/mini-apps/troubleshooting/how-search-works"
},
{
"source": "/base-app/build-with-minikit/search-and-discovery",
"destination": "/mini-apps/technical-guides/search-and-discovery"
"destination": "/mini-apps/troubleshooting/how-search-works"
},
{
"source": "/base-app/miniapps/sharing-your-miniapp",
Expand Down
1 change: 0 additions & 1 deletion docs/mini-apps/core-concepts/embeds-and-previews.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,3 @@ Splash screen background color. Must be hex color code. Defaults to manifest spl
Learn how to maximize sharing, social engagement, and viral growth for your Mini App using Base's social graph features.
</Card>
</CardGroup>

6 changes: 1 addition & 5 deletions docs/mini-apps/core-concepts/manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,7 @@ Open Graph image. 1200×630px (1.91:1), PNG/JPG.

## Related Concepts

<CardGroup cols={2}>
<Card title="Search and Discovery" href="/mini-apps/technical-guides/search-and-discovery">
Learn how your manifest powers search indexing and category placement in the Base app discovery features.
</Card>

<CardGroup cols={1}>
<Card title="Embeds and Previews" href="/mini-apps/core-concepts/embeds-and-previews">
Understand how your manifest creates rich embeds when your Mini App is shared in feeds and social platforms.
</Card>
Expand Down
4 changes: 2 additions & 2 deletions docs/mini-apps/growth/optimize-onboarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Deliver value instantly and avoid blocking actions.

<Step title="Celebrate and amplify">
- After success, prompt social actions via [SDK actions](/mini-apps/features/links) and [Sharing & Social Graph](/mini-apps/features/sharing-and-social-graph)
- Offer next step: save, follow, or share — optimize with [Search & Discovery](/mini-apps/features/search-and-discovery)
- Offer next step: save, follow, or share — optimize with [Search & Discovery](/mini-apps/troubleshooting/how-search-works)
</Step>
</Steps>

Expand Down Expand Up @@ -103,7 +103,7 @@ Learn how to implement them with [SDK actions](/mini-apps/features/links).
<CardGroup cols={3}>
<Card title="Authentication" icon="key" href="/mini-apps/features/Authentication" />
<Card title="Links & SDK Actions" icon="link" href="/mini-apps/features/links" />
<Card title="Search & Discovery" icon="magnifying-glass" href="/mini-apps/features/search-and-discovery" />
<Card title="Search & Discovery" icon="magnifying-glass" href="/mini-apps/technical-guides/search-discovery" />
</CardGroup>

<CardGroup cols={3}>
Expand Down
4 changes: 2 additions & 2 deletions docs/mini-apps/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export function Providers(props: { children: React.ReactNode }) {
- [Manifest](https://docs.base.org/mini-apps/features/manifest.md) — Manifest
- [Authentication](https://docs.base.org/mini-apps/features/Authentication.md) — Auth
- [Embeds & Previews](https://docs.base.org/mini-apps/features/embeds-and-previews.md) — Embeds
- [Search & Discovery](https://docs.base.org/mini-apps/features/search-and-discovery.md) — Discovery
- [Search & Discovery](https://docs.base.org/mini-apps/technical-guides/search-discovery.md) — Discovery
- [Sharing & Social Graph](https://docs.base.org/mini-apps/features/sharing-and-social-graph.md) — Sharing
- [Notifications](https://docs.base.org/mini-apps/features/notifications.md) — Notifications
- [Links](https://docs.base.org/mini-apps/features/links.md) — Links
Expand Down Expand Up @@ -94,7 +94,7 @@ Source: `https://docs.base.org/mini-apps/overview.md`
- Onboarding: Reduce steps; defer heavy auth until value is shown; prefill from client context.
- Source: `https://docs.base.org/mini-apps/growth/optimize-onboarding.md`
- Discovery: Optimize for search and featuring by following guidelines.
- Source: `https://docs.base.org/mini-apps/features/search-and-discovery.md`
- Source: `https://docs.base.org/mini-apps/technical-guides/search-discovery.md`


## Authentication Best Practices (excerpts)
Expand Down
2 changes: 1 addition & 1 deletion docs/mini-apps/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
- [Hooks: useMiniKit](https://docs.base.org/onchainkit/latest/components/minikit/hooks/useMiniKit.md) — Access frame context and client features

## Optional
- [Search & Discovery](https://docs.base.org/mini-apps/features/search-and-discovery.md) — Indexing and ranking signals in Base App
- [Search & Discovery](https://docs.base.org/mini-apps/technical-guides/search-discovery.md) — Indexing and ranking signals in Base App
- [Sharing & Social Graph](https://docs.base.org/mini-apps/features/sharing-and-social-graph.md) — Viral distribution patterns


2 changes: 1 addition & 1 deletion docs/mini-apps/quickstart/build-checklist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Distribution starts in the feed: compelling previews with a clear image and laun

Be found across surfaces: set a primary category, share once to trigger indexing, and keep assets valid to appear in search and categories.

<Card title="Search & Discovery" icon="magnifying-glass" href="/mini-apps/technical-guides/search-and-discovery" />
<Card title="Search & Discovery" icon="magnifying-glass" href="/mini-apps/troubleshooting/how-search-works" />

## Sharing & Social Graph

Expand Down
2 changes: 1 addition & 1 deletion docs/mini-apps/technical-guides/embeds-and-previews.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ Set `Cache-Control` carefully: long enough for performance (300–600s), short e

Continue with:

- [Search and Discovery](/mini-apps/technical-guides/search-and-discovery)
- [Search and Discovery](/mini-apps/troubleshooting/how-search-works)
- [Manifest](/mini-apps/core-concepts/manifest)


Expand Down
111 changes: 0 additions & 111 deletions docs/mini-apps/technical-guides/search-and-discovery.mdx

This file was deleted.

80 changes: 80 additions & 0 deletions docs/mini-apps/troubleshooting/how-search-works.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: How Search works
description: If your Mini App isn't appearing in the Base app, this guide explains how indexing and search work so you can identify and fix the issue.
---
Indexing is how The Base app adds your Mini App to its catalog, making it discoverable through search and browsing.
Unlike traditional app stores with manual submission, you control when indexing happens. Share your Mini App URL to the social feed, and indexing starts automatically—no review process required.

## How indexing works

Understanding the indexing process helps you diagnose why your Mini App may not be appearing.

<Note>
Your manifest must be properly configured and validated for indexing to work. See [manifest documentation](/mini-apps/core-concepts/manifest) for required fields and validation.
</Note>

<Steps>
<Step title="Share your Mini App URL">
Share your URL to the feed.
</Step>
<Step title="The Base app validates your manifest">
The Base app fetches and validates your manifest file.
<Warning>
Invalid or unreachable manifests will fail indexing.
</Warning>
</Step>
<Step title="Your app enters the directory">
Your Mini App is recorded and becomes searchable within 10 minutes.
</Step>
</Steps>


## How search works
The Base App's search queries your Mini App's `name` field from the catalog. Both exact and partial matches appear in results. Search displays your Mini App based on information you provided in your manifest.

<Frame caption="Search results in The Base app">
<img src="/images/minikit/search.jpg" alt="search bar in the Base app" className="h-18 w-auto" />
</Frame>

<Note>
When making changes to your manifest, you will need to share your URL to reindex.
</Note>

## Discovery surfaces

### Category browsing
Your app appears in the category specified by `primaryCategory` in your manifest. Users browse categories to discover apps by interest.

<Frame caption="App Categories">
<img src="/images/minikit/categories.jpg" alt="app categories" className="h-18 w-auto"/>
</Frame>

<Note>
**Category rankings**: Rankings use 7-day engagement metrics such as shares.
</Note>

### Saved apps
When users save your Mini App, it appears in their personal saved options for quick access. Prompt users to save at key moments.

<Frame caption="Saved Apps">
<img src="/images/minikit/my-apps.jpg" alt="saved apps" className="h-18 w-auto"/>
</Frame>

### Direct messages

When users share your Mini App URL in a direct message, it displays as an interactive embed. Recipients can preview and open your app directly from the conversation, with `context.location` set to `messaging` so you can customize the experience for shared discovery.

## Related

<CardGroup cols={2}>
<Card title="Manifest Configuration" href="/mini-apps/core-concepts/manifest">
Configure name and metadata for indexing.
</Card>
<Card title="Embeds & Previews" href="/mini-apps/core-concepts/embeds-and-previews">
Add required embed metadata.
</Card>
<Card title="Troubleshooting" href="/mini-apps/troubleshooting/common-issues">
Complete debugging guide.
</Card>
</CardGroup>

Loading