Skip to content

Commit a39e627

Browse files
authored
Optional Farcaster Manifest in Frames v2 spec (base#390)
<!-- start pr-codex --> ## PR-Codex overview This PR updates the documentation regarding the specifications for valid frame URLs, particularly clarifying the role of the manifest file and its optional nature. ### Detailed summary - Clarified that a valid frame URL includes an embed tag in its HTML `<head>` and may optionally include a manifest file. - Changed wording to specify that frames should provide a JSON manifest file at the URI `/.well-known/farcaster.json`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
1 parent 0ad4aba commit a39e627

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/developers/frames/v2/spec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Here's an example of a frame using a wallet to complete a transaction:
2222

2323
## Frame URL Specifications
2424

25-
A URL is considered a valid frame if it includes an embed tag in its HTML `<head>` and a manifest file at a well known location at the root of the domain.
25+
A URL is considered a valid frame if it includes an embed tag in its HTML `<head>`. An optional manifest file at a well known location at the root of the domain can be provided for additional provenance and appearance information for Farcaster clients.
2626

2727
### Versioning
2828

@@ -90,7 +90,7 @@ type FrameEmbed = {
9090

9191
The manifest file declares the metadata that is applied to the frame application served from this domain. It also defines triggers that indicate which actions it supports from trigger points like casts and the composer.
9292

93-
Frame servers must provide a JSON manifest file on their domain at the well known URI `/.well-known/farcaster.json`.
93+
Frame should provide a JSON manifest file on their domain at the well known URI `/.well-known/farcaster.json`.
9494

9595
```ts
9696
type FarcasterManifest = {

0 commit comments

Comments
 (0)