Skip to content
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

Correct text #333

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Correct text #333

wants to merge 5 commits into from

Conversation

savvar9991
Copy link

@savvar9991 savvar9991 commented Nov 27, 2024

  1. Color Scale Documentation

    • satisfy the contrast ratio against when used on top of XXX-soft
    • satisfy the contrast ratio when used on top of XXX-soft
  2. Authentication Documentation

    • Updated hook documentation for clarity:
    • You signed: {message}

    • You signed in with: {message}

    • Your signature: {signature}

    • Your signed message: {signature}

  3. Sign-In Documentation

    • Standardized terminology from "SIWF" to "SIWE"
    • Updated parameter descriptions for accuracy
    • Fixed table formatting and descriptions
  4. Frames Documentation

    • Fixed typo: "unathenticated" → "unauthenticated"
    • Standardized JSON field casing: "url" → "URL"

Changed "Each colors" to "Each color" to correctly use the singular.
Clarified the description of "contrast ratio against when used on top of" to "contrast ratio when used on top of" to improve readability.
In the Auth Client section there is an extra comma after the last element in the items array
- **"You signed up"** → **"You signed in with:"**: more accurate description, appropriate for the authentication context.
- **"Your signature"** → **"Your signed message"**: this better captures the essence of what is manifested in the `signature`
"SIWF message" - it should be "SIWE message" because SIWE (Sign In With Ethereum) is a message standard, not SIWF.

"The Sign In With Farcaster URL" - it would be more correct to say "Sign In With Farcaster URL" without "The" because it is a specific URL in the context of this library.

"AuthKit state" - it should be "Auth client state" because it is more related to the state of the authentication client.
Here "unauthenticated" should be replaced with "unauthenticated".
In the context of technical descriptions, "URL" is usually written with capital letters.
Copy link

vercel bot commented Nov 27, 2024

@savvar9991 is attempting to deploy a commit to the farcaster Team on Vercel.

A member of the Team first needs to authorize it.

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.

1 participant