Skip to content

Fix/documentation typos #2272

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 2 commits into
base: master
Choose a base branch
from
Open

Conversation

wamimi
Copy link
Contributor

@wamimi wamimi commented Apr 25, 2025

What changed? Why?
Fixed typos and formatting issues in documentation files to improve readability and professionalism:

  1. In MiniKit overview.mdx:

    • Added missing "the" in "MiniKit is the easiest way"
  2. In MiniKit quickstart.mdx:

    • Fixed various typos:
      • "easist" → "easiest"
      • "exisitng" → "existing"
      • "applie" → "applies"
      • "elimintaing" → "eliminating"
      • "Farcster" → "Farcaster"
      • "teamplate" → "template"
      • "contorls" → "controls"
      • "socail" → "social"
  3. In Basenames tutorial:

    • Added period for better readability in the tip section
    • Fixed duplicate import statements syntax
    • Added missing semicolon and closing brace to interface definition

These fixes make the documentation more professional and easier to follow, improving the developer experience when implementing MiniKit and Basenames features.

Notes to reviewers
These are simple typo and syntax fixes that maintain the original meaning of the text while improving readability.

How has it been tested?
I've verified that the markdown renders correctly with the changes and that the syntax in code examples is valid.

Have you tested the following pages?

BaseWeb

  • [] base.org
  • [] base.org/names
  • [] base.org/builders
  • [] base.org/ecosystem
  • [] base.org/name/jesse
  • [] base.org/manage-names
  • [] base.org/resources

BaseDocs

  • docs.base.org/builderkits/minikit/overview - Verified fix for "the easiest way"
  • docs.base.org/builderkits/minikit/quickstart - Verified all typo fixes
  • docs.base.org/identity/basenames/basenames-onchainkit-tutorial - Verified syntax and formatting fixes
  • [] docs sub-pages

Copy link

vercel bot commented Apr 25, 2025

@wamimi is attempting to deploy a commit to the Coinbase Team on Vercel.

A member of the Team first needs to authorize it.

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Apr 25, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 1/2
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

@wbnns wbnns added the base docs review To be reviewed by the Base docs team label May 8, 2025
Copy link
Contributor

@wbnns wbnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
base docs review To be reviewed by the Base docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants