Skip to content

Commit 739ef70

Browse files
authored
minor docs updates (base#398)
- fix broken link on "see full example" on the frames spec page - update `primaryButtonClick` to `primaryButtonClicked` - remove broken wallet image - fix minor format <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on improving the documentation for the `Frames` and `Sign In with Farcaster (SIWF)` features, correcting grammatical errors and enhancing clarity throughout various markdown files. ### Detailed summary - Corrected "a way" to "a way" in `docs/developers/siwf/index.md`. - Updated bullet points to start with capital letters in `docs/developers/siwf/index.md`. - Fixed "an click-through" to "a click-through" in `docs/developers/frames/v2/getting-started.md`. - Changed "servers" to "serves" in multiple instances in `docs/developers/frames/v2/notifications_webhooks.md` and `docs/developers/frames/v2/spec.md`. - Updated event name from "primaryButtonClick" to "primaryButtonClicked" in `docs/developers/frames/v2/spec.md`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent df09352 commit 739ef70

File tree

5 files changed

+14
-16
lines changed

5 files changed

+14
-16
lines changed

docs/developers/frames/v2/getting-started.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ $ ngrok http http://localhost:3000
286286
```
287287

288288
::: info Tunneling gotchas
289-
Some tunneling tools, like the ngrok free tier, insert an click-through interstitial between your dev server and the tunnel endpoint. Use a paid ngrok account or a different tool, like Tailscale funnel.
289+
Some tunneling tools, like the ngrok free tier, insert a click-through interstitial between your dev server and the tunnel endpoint. Use a paid ngrok account or a different tool, like Tailscale funnel.
290290
:::
291291

292292
Now open the Frame Playground on Warpcast mobile, by visiting [https://warpcast.com/~/developers/frame](https://warpcast.com/~/developers/frames).
@@ -658,8 +658,6 @@ export default function Demo() {
658658
}
659659
```
660660

661-
<img src="https://raw.githubusercontent.com/farcasterxyz/frames-v2-demo/refs/heads/main/docs/img/10_wallet.png" width="200" alt="Wallet" />
662-
663661
If your wallet is connected to Warpcast, you should see its address. In case it's not, let's add a connect/disconnect button. Note that we'll need to import our Wagmi config to `connect`:
664662

665663
```tsx

docs/developers/frames/v2/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Frames v2 Introduction
22

3-
[Frames](../index.md) launched in January 2024 as a a way to build interactive apps that run directly in a Farcaster social feed. They enabled developers to identify users, connect wallets, and take limited actions on and offchain.
3+
[Frames](../index.md) launched in January 2024 as a way to build interactive apps that run directly in a Farcaster social feed. They enabled developers to identify users, connect wallets, and take limited actions on and offchain.
44

55
Although we saw many apps built, they were held back by several limitations:
66

docs/developers/frames/v2/notifications_webhooks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export type SendNotificationResponse = z.infer<
137137

138138
The request is a JSON consisting of:
139139

140-
- `notificationId`: a string (max size 128) that servers as an idempotency key and will be passed back to the frame via context. A Farcaster client should deliver only one notification per user per `notificationId`, even if called multiple times.
140+
- `notificationId`: a string (max size 128) that serves as an idempotency key and will be passed back to the frame via context. A Farcaster client should deliver only one notification per user per `notificationId`, even if called multiple times.
141141
- `title`: title of the notification, max 32 characters
142142
- `body`: body of the notification, max 128 characters
143143
- `targetUrl`: the target frame URL to open when a user clicks the notification. It must match the domain for which the notification token was issued. Max 256 characters.
@@ -172,7 +172,7 @@ export type FrameLocationNotificationContext = {
172172

173173
## Listen for webhooks to get updates
174174

175-
Farcast clients will POST events to your `webhookUrl` informing you when a user:
175+
Farcaster clients will POST events to your `webhookUrl` informing you when a user:
176176

177177
- Adds the frame to the client (`frame_added`)
178178
- Removes the frame from the client which disables notifications (`frame_removed`)
@@ -242,7 +242,7 @@ Webhook payload:
242242

243243
### `notifications_disabled`: user disabled notifications
244244

245-
Sent when a disables frame notifications from e.g. a settings panel in the client app. Any notification tokens for that fid and client app (based on signer requester) should be considered invalid:
245+
Sent when a user disables frame notifications from e.g. a settings panel in the client app. Any notification tokens for that fid and client app (based on signer requester) should be considered invalid:
246246

247247
Webhook payload:
248248

docs/developers/frames/v2/spec.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It can be embedded in feeds in a compact form which includes an image and a butt
1010

1111
<img width="1330" alt="Screenshot 2024-11-20 at 7 28 48 PM" src="https://github.com/user-attachments/assets/9d076056-f8df-46dd-8630-e8caf5b3def4">
1212

13-
Frames will have access to :
13+
Frames will have access to:
1414

1515
1. Context: information about the user's Farcaster account and where the frame was called from
1616
2. Actions: APIs to request the parent app to do certain things on the frame's behalf
@@ -836,7 +836,7 @@ type EventNotificationsEnabledPayload = {
836836

837837
Farcaster clients emit events to your frame, while it is open, to let you know of actions the user takes.
838838

839-
To listen to events, you have to use `sdk.on` to register callbacks ([see full example](https://github.com/farcasterxyz/frames-v2-demo/blob/20d454f5f6b1e4f30a6a49295cbd29ca7f30d44a/src/components/Demo.ts#L92-L124)).
839+
To listen to events, you have to use `sdk.on` to register callbacks ([see full example](https://github.com/farcasterxyz/frames-v2-demo/blob/20d454f5f6b1e4f30a6a49295cbd29ca7f30d44a/src/components/Demo.tsx#L92-L124)).
840840

841841
```ts
842842
sdk.on('frameAdded', ({ notificationDetails }) => {
@@ -891,7 +891,7 @@ The frame server is given an authentication token and a URL which they can use t
891891

892892
The frame server calls the `notificationUrl` with:
893893

894-
- `notificationId`: a string (max size 128) that servers as an idempotency key and will be passed back to the frame via context. A Farcaster client should deliver only one notification per user per `notificationId`, even if called multiple times.
894+
- `notificationId`: a string (max size 128) that serves as an idempotency key and will be passed back to the frame via context. A Farcaster client should deliver only one notification per user per `notificationId`, even if called multiple times.
895895
- `title`: title of the notification, max length of 32 characters
896896
- `body`: body of the notification
897897
- `targetUrl`: the target frame URL to open when a user clicks the notification. It must match the domain for which the notification token was issued.
@@ -1016,12 +1016,12 @@ type SetPrimaryButton = (options: {
10161016

10171017
An app frame should subscribe to the `primaryButtonClicked` event to respond to interactions.
10181018

1019-
### primaryButtonClick (Event)
1019+
### primaryButtonClicked (Event)
10201020

10211021
Emitted when user clicks the Primary Button.
10221022

10231023
```ts
1024-
> Farcaster.events.on("primaryButtonClick", () => {
1024+
> Farcaster.events.on("primaryButtonClicked", () => {
10251025
console.log("clicked!") }
10261026
);
10271027
```

docs/developers/siwf/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Sign In with Farcaster
44

55
# Introduction
66

7-
Sign In with Farcaster (SIWF) is way for users to sign into any app using their
7+
Sign In with Farcaster (SIWF) is a way for users to sign into any app using their
88
Farcaster identity.
99

1010
When a user signs into your application with Farcaster you'll be able to use
@@ -22,6 +22,6 @@ a streamlined onboarding experience and social-powered features.
2222

2323
## Next Steps
2424

25-
- integrate SIWF to your app today with [AuthKit](/auth-kit/).
26-
- read about the underlying standard in [FIP-11: Sign In With
27-
Farcaster](https://github.com/farcasterxyz/protocol/discussions/110)
25+
- Integrate SIWF to your app today with [AuthKit](/auth-kit/).
26+
- Read about the underlying standard in [FIP-11: Sign In With
27+
Farcaster](https://github.com/farcasterxyz/protocol/discussions/110).

0 commit comments

Comments
 (0)