Skip to content

docs(migration): add missing notifications.md for MiniKit to Farcaster - #58

Open
faisalnugroho wants to merge 1 commit into
base:masterfrom
faisalnugroho:fix/add-notifications-md
Open

docs(migration): add missing notifications.md for MiniKit to Farcaster#58
faisalnugroho wants to merge 1 commit into
base:masterfrom
faisalnugroho:fix/add-notifications-md

Conversation

@faisalnugroho

Copy link
Copy Markdown

What

Adds the missing notifications.md file that mapping.md references for server-side notification implementation during MiniKit to Farcaster migration.

The problem

mapping.md references NOTIFICATIONS.md in two places (lines 412 and 452):

See [NOTIFICATIONS.md](NOTIFICATIONS.md) for server-side implementation.

But that file doesn't exist. Anyone following the migration guide for the notification section hits a dead link and has to figure out the Farcaster notification API on their own.

What's in the new file

Created notifications.md with:

  1. Overview — explains the shift from client-side (MiniKit) to server-side (Farcaster SDK) notifications
  2. Webhook registration — how to register your app's notification endpoint
  3. Token storage — how to store user notification tokens when they opt in
  4. Server-side send — complete example of sending notifications via the Farcaster API, including handling expired tokens
  5. Client-side trigger — minimal client code that calls your server endpoint
  6. Comparison table — key differences between MiniKit and Farcaster SDK notification patterns
  7. Security notes — API key handling, rate limiting, token validation

Also fixed the link casing (NOTIFICATIONS.mdnotifications.md) to match the actual filename.

Fixes #30

The mapping.md file referenced NOTIFICATIONS.md in two places for
server-side notification implementation, but the file didn't exist.
Anyone following the migration guide would hit a broken link.

Created notifications.md with:
- Webhook registration steps
- User notification token storage
- Server-side send implementation
- Client-side trigger pattern
- Key differences table from MiniKit
- Security notes

Also fixed the link casing to match the actual filename.

Fixes base#30
@cb-heimdall

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

@faisalnugroho

Copy link
Copy Markdown
Author

Hi! Following up on this docs PR. This PR adds the missing notifications.md migration doc for the MiniKit to Base App transition, fixing a broken internal reference in the migration guide.

All CI checks pass (StepSecurity ✅). Would love to get your review when you have a moment. Thanks!

@faisalnugroho

Copy link
Copy Markdown
Author

Hi! I'd love to get this PR reviewed when you have a moment. This PR addresses add missing notifications.md for MiniKit to Farcaster migration. Happy to make any adjustments based on your feedback. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing NOTIFICATIONS.md reference in MiniKit to Farcaster migration mapping

2 participants