-
Notifications
You must be signed in to change notification settings - Fork 289
search-discovery #490
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
Merged
Merged
search-discovery #490
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
c8cddb2
streamlined
soheimam 9039477
Merge branch 'master' into docs/search-discovery-rework
soheimam 4fc43cf
added direct messging as a surface
soheimam aec761d
added direct messging as a surface
soheimam 7923c65
added search section
soheimam b0ba69e
added search section
soheimam a39025d
undid embed changes
soheimam 51cd77c
rechanged title
soheimam e4d7410
Merge branch 'master' into docs/search-discovery-rework
soheimam 1cdf742
moved search and discovery from technical to troubleshooting
soheimam 7beb460
moved search and discovery from technical to troubleshooting updated …
soheimam a5c8ca8
moved search and discovery from technical to troubleshooting updated …
soheimam f2d4d8c
moved search and discovery from technical to troubleshooting updated …
soheimam 9faeac5
Merge branch 'master' into docs/search-discovery-rework
soheimam 38c519c
removed search discover debugging from manifest
soheimam 9819ec1
fixed typo
soheimam f71630b
added rules for base app spelling
soheimam fe46536
fixed merge conflicts
soheimam File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
111 changes: 0 additions & 111 deletions
111
docs/mini-apps/technical-guides/search-and-discovery.mdx
This file was deleted.
Oops, something went wrong.
soheimam marked this conversation as resolved.
Show resolved
Hide resolved
|
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
| 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. | ||
soheimam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | ||
soheimam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </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> | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.