diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 586d4a07..2bd6788d 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -7,7 +7,7 @@ * The primitive colors used for accent colors. These colors are referenced * by functional colors such as "Text", "Background", or "Brand". * - * Each color have exact same color scale system with 3 levels of solid + * Each color has exact same color scale system with 3 levels of solid * colors with different brightness, and 1 soft color. * * - `XXX-1`: The most solid color used mainly for colored text. It must @@ -15,7 +15,7 @@ * * - `XXX-2`: The color used mainly for hover state of the button. * - * - `XXX-3`: The color for solid background, such as bg color of the button. + * - `XXX-3`: The color for a solid background, such as bg color of the button. * It must satisfy the contrast ratio with pure white (#ffffff) text on * top of it. * @@ -23,9 +23,9 @@ * or badges. It must satisfy the contrast ratio when putting `XXX-1` colors * on top of it. * - * The soft color must be semi transparent alpha channel. This is crucial + * The soft color must be semi semi-transparent alpha channel. This is crucial * because it allows adding multiple "soft" colors on top of each other - * to create a accent, such as when having inline code block inside + * to create an accent, such as when having an inline code block inside * custom containers. * -------------------------------------------------------------------------- */ diff --git a/docs/auth-kit/client/wallet/parse-sign-in-uri.md b/docs/auth-kit/client/wallet/parse-sign-in-uri.md index 9eebe2b1..ff4af479 100644 --- a/docs/auth-kit/client/wallet/parse-sign-in-uri.md +++ b/docs/auth-kit/client/wallet/parse-sign-in-uri.md @@ -4,7 +4,7 @@ Parse the Sign In With Farcaster URI provided by a connected app user. Returns the parsed parameters. Your app should use these to construct a Sign In With Farcaster message. -Returns an error if URI is invalid. +Returns an error if the URI is invalid. ```ts const params = walletClient.parseSignInURI({ diff --git a/docs/auth-kit/sign-in-button.md b/docs/auth-kit/sign-in-button.md index 6fda15a5..ac73369f 100644 --- a/docs/auth-kit/sign-in-button.md +++ b/docs/auth-kit/sign-in-button.md @@ -1,6 +1,6 @@ # `SignInButton` -The main component. Renders a "Sign in With Farcaster" button that prompts the user to scan a QR code with their phone in a web browser or redirects to a mobile device. You can use the `onSuccess` callback prop or the `useProfile` hook to access the user's authentication status and profile information. +The main component. Renders a "Sign in With Farcaster" button that prompts the user to scan a QR code with their phone in a web browser or redirect to a mobile device. You can use the `onSuccess` callback prop or the `useProfile` hook to access the user's authentication status and profile information. **Note:** Make sure you've wrapped your application in an [`AuthKitProvider`](./auth-kit-provider.md) to use the `SignInButton` component. diff --git a/docs/developers/frames/v2/getting-started.md b/docs/developers/frames/v2/getting-started.md index e68e1fb3..e9533cd8 100644 --- a/docs/developers/frames/v2/getting-started.md +++ b/docs/developers/frames/v2/getting-started.md @@ -36,7 +36,7 @@ $ yarn create next-app Creating a new Next.js app in /Users/horsefacts/Projects/frames-v2-demo. ``` -Next, install frame related dependencies. We'll need the official frame SDK: +Next, install frame-related dependencies. We'll need the official frame SDK: ```bash $ yarn add @farcaster/frame-sdk @@ -52,7 +52,7 @@ OK, we're ready to get started! ### Configuring providers -We'll need to set up a custom Wagmi connector in order to interact with the user's Farcaster wallet. Since the frames SDK is a frontend only package, we'll also need to use client components and [Next dynamic imports](https://nextjs.org/docs/pages/building-your-application/optimizing/lazy-loading#nextdynamic) in a few places. +We'll need to set up a custom Wagmi connector in order to interact with the user's Farcaster wallet. Since the frames SDK is a frontend-only package, we'll also need to use client components and [Next dynamic imports](https://nextjs.org/docs/pages/building-your-application/optimizing/lazy-loading#nextdynamic) in a few places. First, let's create a custom connector component at `lib/connector.ts`. We'll use this to connect to the user's Farcaster wallet from our app. diff --git a/docs/developers/frames/v2/index.md b/docs/developers/frames/v2/index.md index 83f83b01..81baea28 100644 --- a/docs/developers/frames/v2/index.md +++ b/docs/developers/frames/v2/index.md @@ -1,6 +1,6 @@ # Frames v2 Introduction -[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. +[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. Although we saw many apps built, they were held back by several limitations: @@ -18,7 +18,7 @@ We're working on a new frame standard to enable richer social applications. New features include: -- A full screen interactive canvas based on HTML/CSS/Javascript +- A full-screen interactive canvas based on HTML/CSS/Javascript - Reliable and fast mobile wallet transactions - Ability to save, search, and discover frames - Access to native mobile notifications diff --git a/docs/developers/frames/v2/notifications_webhooks.md b/docs/developers/frames/v2/notifications_webhooks.md index f9b6aa46..53142858 100644 --- a/docs/developers/frames/v2/notifications_webhooks.md +++ b/docs/developers/frames/v2/notifications_webhooks.md @@ -4,9 +4,9 @@ title: Frames v2 Notifications & Webhooks # Frames v2 Notifications & Webhooks -Frames v2 allow developers to send notifications to users who have "added" the frame to their Farcaster client and enabled notifications. +Frames v2 allows developers to send notifications to users who have "added" the frame to their Farcaster client and enabled notifications. -In Warpcast, these are **in-app notifications** that trigger the red dot on the notifications tab. At this stage there is no support for push notifications. +In Warpcast, these are **in-app notifications** that trigger the red dot on the notifications tab. At this stage, there is no support for push notifications. The steps to successfully send a notification are: @@ -137,7 +137,7 @@ export type SendNotificationResponse = z.infer< The request is a JSON consisting of: -- `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. +- `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. - `title`: title of the notification, max 32 characters - `body`: body of the notification, max 128 characters - `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.