Skip to content

Docs improvements #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/auth-kit/client/wallet/parse-sign-in-uri.md
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Apps should consider the following mechanisms to protect users against malicious
1. Transaction simulation.
2. Domain allowlisting and banlisting to stop known attackers.
3. Social graph analysis to detect potential bad or untrusted actors.
4. Educating users about the potential dangerous of transactions and using a wallet with limited balances.
4. Educating users about the potential dangers of transactions and using a wallet with limited balances.

## Data Structures

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/frames/v2/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Here's a full walkthrough of creating a frames v2 app:

## Tutorial

The following tutorial is based on the [Frames v2 Demo](https://github.com/farcasterxyz/frames-v2-demo) repo on Github.
The following tutorial is based on the [Frames v2 Demo](https://github.com/farcasterxyz/frames-v2-demo) repo on GitHub.

### Setup and dependencies

Expand Down Expand Up @@ -286,7 +286,7 @@ $ ngrok http http://localhost:3000
```

::: info Tunneling gotchas
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.
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.
:::

Now open the Frame Playground on Warpcast mobile, by visiting [https://warpcast.com/~/developers/frame](https://warpcast.com/~/developers/frames).
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/v2/index.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/v2/notifications_webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/v2/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ bottom of the view.

### actions.ready

Indicates that the application is fully loaded and ready to displayed to users. Once this is called the loading screen will be hidden. Frame applications MUST call `ready()` to display their app.
Indicates that the application is fully loaded and ready to be displayed to users. Once this is called the loading screen will be hidden. Frame applications MUST call `ready()` to display their app.

```ts
> await sdk.actions.ready();
Expand Down