Skip to content

Commit 5654dec

Browse files
hughescoinsoheimam
andauthored
Swap Farcaster tool with Preview Tool across docs (#331)
* Update Test & Deploy page to reference Preview tool * fix link to Launch Checklist * Swap Farcaster tool with Base Build Preview tool * swap Farcaster tool with Preview tool for cookbook section * updated links to v0 template (#328) * add links for getting help section * add preview tool image * add Preview Tool callouts to Common Issues & Debugging page * add Preview tool callout to manifest * fix working for callout * Add preview tool account association feature to Create Manifest page * add preview tool callout in create manifest --------- Co-authored-by: Sohey <[email protected]>
1 parent 2526dec commit 5654dec

File tree

9 files changed

+99
-13
lines changed

9 files changed

+99
-13
lines changed

docs/cookbook/minikit/test-and-deploy.mdx

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,32 @@ Before sharing your Mini App, validate everything works.
1212
- `/.well-known/farcaster.json` returns valid JSON
1313
- `fc:frame` metadata renders a launch button when shared
1414

15-
## Validation tools
15+
## Validation Tools
16+
17+
[Base Build](https://base.dev) is the place to test and validate your Mini App. In addition to tracking your app’s usage and redeeming builder rewards, it includes a **Preview tool**, which helps you:
18+
19+
- Validate your app's manifest and metadata
20+
- Test how your app will appear in the Base app
21+
- Verify ownership and account association
22+
23+
The Preview tool provides clear visual cues:
24+
- ✅ Green check marks when things are set up correctly
25+
- ❌ Red indicators when something needs your attention
26+
27+
### Components of the Preview Tool
28+
29+
The Preview tool has three main components:
30+
31+
- **Console**: Preview your app and review logs to make informed decisions about performance.
32+
- **Account Association**: Confirm your app is linked to the correct account, signatures are valid, and the domain matches what’s specified in the manifest.
33+
- **Metadata**: Ensure your Mini App renders exactly as expected by verifying required fields like name, icon, tags, and splash image.
34+
35+
### Getting Started
36+
37+
1. [Import your app](https://docs.base.org/mini-apps/growth/data-driven-growth) into Base Build
38+
2. Visit the [Preview tool](https://base.dev/preview) to begin validating your app
39+
1640

17-
- Manifest Tool: `https://farcaster.xyz/~/developers/mini-apps/manifest`
18-
- Embed Tool: `https://farcaster.xyz/~/developers/mini-apps/embed`
1941

2042
## Share and test
2143

@@ -24,7 +46,7 @@ Before sharing your Mini App, validate everything works.
2446
3. Test launch and frame readiness
2547

2648
<CardGroup cols={2}>
27-
<Card title="Launch Checklist" icon="rocket" href="/mini-apps/quickstart/launch-guide">
49+
<Card title="Launch Checklist" icon="rocket" href="/mini-apps/quickstart/launch-checklist">
2850
Follow the launch checklist to get the most out of your mini app.
2951
</Card>
3052
<Card title="Troubleshooting" icon="bug" href="/mini-apps/troubleshooting/common-issues">
105 KB
Loading
279 KB
Loading

docs/mini-apps/features/embeds-and-previews.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ export async function generateMetadata(): Promise<Metadata> {
232232

233233
### Tools
234234

235-
<Card title="Farcaster Embed Debugger" icon="bug" href="https://farcaster.xyz/~/developers/mini-apps/debug">
236-
Test your metadata and preview embeds
235+
<Card title="Base Build Preview Tool" icon="bug" href="https://base.dev/preview">
236+
Test how your app will appear in the Base app by validating your manifest, embeds, and account association
237237
</Card>
238238

239239
### Common issues

docs/mini-apps/features/manifest.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ description: Define and configure your Mini App’s manifest to power search, di
1212
> - Control indexing for staging and production with `noindex`.
1313
1414
## Overview
15+
<Tip>The best way to validate your manifest is by using Base Build's built-in [Preview tool](https://base.dev/preview)</Tip>
1516

1617
Your `/.well-known/farcaster.json` file is the manifest for your Mini App. It contains all the metadata Base App uses to:
1718

docs/mini-apps/quickstart/existing-apps/create-manifest.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ export async function GET() {
5252
}
5353
```
5454

55+
## Testing using Preview Tool
56+
57+
Use [Base Build's Preview tool](https://base.dev) to validate your manifest and test how your app appears in the Base app.
58+
59+
The tool provides instant feedback with ✅ green checks when everything is set up correctly and ❌ red indicators when something needs attention.
60+
61+
5562
Review the full [Manifest guide](/mini-apps/features/manifest) and update all fields. Be sure to update your deployment environment with these values.
5663

5764

docs/mini-apps/quickstart/existing-apps/test-and-deploy.mdx

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,32 @@ Before sharing your Mini App, validate everything works.
1212
- `/.well-known/farcaster.json` returns valid JSON
1313
- `fc:frame` metadata renders a launch button when shared
1414

15-
## Validation tools
15+
## Validation Tools
16+
17+
[Base Build](https://base.dev) is the place to test and validate your Mini App. In addition to tracking your app’s usage and redeeming builder rewards, it includes a **Preview tool**, which helps you:
18+
19+
- Validate your app's manifest and metadata
20+
- Test how your app will appear in the Base app
21+
- Verify ownership and account association
22+
23+
The Preview tool provides clear visual cues:
24+
- ✅ Green check marks when things are set up correctly
25+
- ❌ Red indicators when something needs your attention
26+
27+
### Components of the Preview Tool
28+
29+
The Preview tool has three main components:
30+
31+
- **Console**: Preview your app and review logs to make informed decisions about performance.
32+
- **Account Association**: Confirm your app is linked to the correct account, signatures are valid, and the domain matches what’s specified in the manifest.
33+
- **Metadata**: Ensure your Mini App renders exactly as expected by verifying required fields like name, icon, tags, and splash image.
34+
35+
### Getting Started
36+
37+
1. [Import your app](https://docs.base.org/mini-apps/growth/data-driven-growth) into Base Build
38+
2. Visit the [Preview tool](https://base.dev/preview) to begin validating your app
39+
1640

17-
- Manifest Tool: `https://farcaster.xyz/~/developers/mini-apps/manifest`
18-
- Embed Tool: `https://farcaster.xyz/~/developers/mini-apps/embed`
1941

2042
## Share and test
2143

@@ -24,7 +46,7 @@ Before sharing your Mini App, validate everything works.
2446
3. Test launch and frame readiness
2547

2648
<CardGroup cols={2}>
27-
<Card title="Launch Checklist" icon="rocket" href="/mini-apps/quickstart/launch-guide">
49+
<Card title="Launch Checklist" icon="rocket" href="/mini-apps/quickstart/launch-checklist">
2850
Follow the launch checklist to get the most out of your mini app.
2951
</Card>
3052
<Card title="Troubleshooting" icon="bug" href="/mini-apps/troubleshooting/common-issues">

docs/mini-apps/quickstart/new-apps/create-manifest.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Review the full [Manifest guide](/mini-apps/features/manifest) and update all fi
2727
While testing, set `noindex: true` in your manifest to avoid indexing.
2828
</Warning>
2929

30+
## Account association
31+
The account association verifies ownership of a domain to a Farcaster account.
32+
33+
![Metadata Guidelines](/images/base-build/account-association.png)
34+
35+
<Tip>Account association can be validated using the Base Build's [Preview tool](https://base.dev/preview).</Tip>
36+
3037
## `/.well-known/farcaster.json`
3138

3239
The manifest exists in `app/.well-known/farcaster.json/route.ts` which returns your accountAssociation and mini app properties. Ensure all asset URLs are HTTPS and publicly accessible.

docs/mini-apps/troubleshooting/common-issues.mdx

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,32 @@ your-domain.com/
2424
- Manifest file exists at `/.well-known/farcaster.json`
2525
- All image URLs are publicly accessible
2626

27+
# Debugging
28+
Use Base Build's built-in Preview Tool for foundational debugging.
29+
30+
<Card title="Preview Tool" img="/images/base-build/preview-tool-overview.png">
31+
Start debugging your app using the [Preivew tool](https://base.dev/preview)
32+
</Card>
33+
34+
The **Preview tool** will help you:
35+
36+
- Validate your app's manifest and metadata
37+
- Test how your app will appear in the Base app
38+
- Verify ownership and account association
39+
40+
The Preview tool provides clear visual cues:
41+
- ✅ Green check marks when things are set up correctly
42+
- ❌ Red indicators when something needs your attention
43+
44+
### Components of the Preview Tool
45+
46+
The Preview tool has three main components:
47+
48+
- **Console**: Preview your app and review logs to make informed decisions about performance.
49+
- **Account Association**: Confirm your app is linked to the correct account, signatures are valid, and the domain matches what’s specified in the manifest.
50+
- **Metadata**: Ensure your Mini App renders exactly as expected by verifying required fields like name, icon, tags, and splash image.
51+
52+
2753
### Basic Validation Steps
2854

2955
1. Test manifest accessibility: visit `https://yourdomain.com/.well-known/farcaster.json`
@@ -32,6 +58,8 @@ your-domain.com/
3258

3359
## Quick Diagnostic Workflow
3460

61+
<Tip>The best way to validate your app works is by using Base Build's built-in [Preview tool](https://base.dev/preview)</Tip>
62+
3563
- Not appearing in search? → App Discovery & Indexing Issues
3664
- Not rendering as an embed? → Embed Rendering Issues
3765
- Wallet connection problems? → Wallet Connection Problems
@@ -197,10 +225,9 @@ Basic functionality and discovery/sharing checklists: confirm load, images, wall
197225

198226
## Getting Additional Help
199227

200-
- Mini App Debug Tool
201-
- Mini App Embed Tool
228+
- [Base Build Preview Tool](https://base.dev/preview)
202229
- JSONLint
203-
- Eruda
230+
- [Eruda](https://github.com/liriliri/eruda)
204231
- Base Discord — #minikit channel
205232

206233

0 commit comments

Comments
 (0)