Skip to content

Commit 72eed37

Browse files
authored
Docs/mini app callout (#156)
* added noIndex suggestion * added noIndex suggestion
1 parent 4862169 commit 72eed37

5 files changed

Lines changed: 23 additions & 4 deletions

File tree

docs/base-app/build-with-minikit/debugging.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,12 @@ your-domain.com/
110110

111111
**Problem**: Your app has a manifest but still doesn't appear in catalogs.
112112

113-
**Solution**: Your Mini App must be shared in a cast to be indexed.
113+
**Solution**: Your Mini App must be shared in a post to be indexed.
114114

115115
**Steps to Index Your App**:
116116

117117
1. Complete your manifest setup
118-
2. Share your Mini App URL in a cast
118+
2. Share your Mini App URL in a post
119119
3. Indexing can take up to 10 minutes
120120
4. Verify appearance in app catalogs
121121

@@ -372,7 +372,7 @@ Before deploying your Mini App, verify these items work correctly:
372372

373373
- [ ] Manifest file is accessible at `/.well-known/farcaster.json`
374374
- [ ] App appears in embed when URL is shared
375-
- [ ] App appears in search results (after casting)
375+
- [ ] App appears in search results (after posting)
376376
- [ ] All required manifest fields are present
377377

378378
## **Getting Additional Help**

docs/base-app/build-with-minikit/existing-app-integration.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,15 @@ export async function GET() {
279279
ogTitle: process.env.NEXT_PUBLIC_APP_OG_TITLE,
280280
ogDescription: process.env.NEXT_PUBLIC_APP_OG_DESCRIPTION,
281281
ogImageUrl: process.env.NEXT_PUBLIC_APP_OG_IMAGE,
282+
// use only while testing
283+
"noindex": true
282284
}),
283285
});
284286
}
285287
```
288+
<Warning>
289+
While testing your Mini App please add noIndex:true to your manifest - this is so the app is not indexed while in developement.
290+
</Warning>
286291

287292
<Check>
288293
Test this endpoint by visiting `https://yourdomain.com/.well-known/farcaster.json` to ensure it returns valid JSON.

docs/base-app/build-with-minikit/quickstart.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,10 @@ Signature from manifest generation
210210

211211
Now that the manifest is correctly set up, the Save Frame button in the template app should work. We'll explore that below.
212212

213+
<Warning>
214+
While testing your Mini App please add noIndex:true to your manifest - this is so the app is not indexed while in developement.
215+
</Warning>
216+
213217
### useAddFrame
214218

215219
The `useAddFrame` hook is used to add your mini app to the user's list of mini apps. It's implemented in your main page component and displays a button in the top right allowing the user to add the mini app to their list.

docs/base-app/introduction/getting-started.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,16 @@ Mini Apps require one configuration file located at `/.well-known/farcaster.json
136136
"https://yourapp.com/screenshot2.png"
137137
],
138138
"primaryCategory": "games",
139-
"tags": ["multiplayer", "strategy", "onchain"],
139+
"tags": ["multiplayer", "strategy", "onchain"],,
140+
// use only while testing
141+
"noindex": true,
140142
"webhookUrl": "https://yourapp.com/api/webhook"
141143
}
142144
}
143145
```
146+
<Warning>
147+
While testing your Mini App, add "noindex": true to your manifest this prevents the app from being indexed during development.
148+
</Warning>
144149

145150
## Categories and Discovery
146151

docs/base-app/introduction/mini-apps.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,14 @@ Note: We **highly recommend** that you set this metadata as it will give your mi
250250
"ogTitle": "Example Mini App",
251251
"ogDescription": "Example Mini App description",
252252
"ogImageUrl": "https://example.com/og.png"
253+
// use only while testing
254+
"noindex": true
253255
}
254256
}
255257
```
258+
<Warning>
259+
While testing your Mini App, add "noindex": true to your manifest this prevents the app from being indexed during development.
260+
</Warning>
256261

257262
## Notifications
258263

0 commit comments

Comments
 (0)