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.

Sign up for GitHub

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

Jump to bottom

Various stylistic, grammatical and typographical errors in documentation #1260

Merged
merged 6 commits into from
Dec 5, 2024
Merged

Various stylistic, grammatical and typographical errors in documentation #1260

merged 6 commits into from
Dec 5, 2024

Conversation

zerod0t
Copy link
Contributor

@zerod0t zerod0t commented Nov 17, 2024

What changed? Why?

  1. Incorrect terminology usage (e.g., "abi" instead of "ABI"), leading to potential confusion when reading and using the code.
  2. Misspellings and incorrect word usage in English (e.g., "confit" instead of "config"), causing misunderstandings.
  3. Typos and inaccuracies in the installation and usage instructions (e.g., "install" instead of "installed").
  4. Lack of clarity in certain directives, making it difficult for users to follow the described steps.
  5. Incorrect formatting and markdown usage, including issues with links and code blocks.

Notes to reviewers

These errors reduce the overall quality of the documentation and may negatively impact user experience, particularly for beginners relying on clear guidance.

How has it been tested?

@vercel Vercel
Copy link

vercel bot commented Nov 17, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
base-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 4:36pm
web-base-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 3, 2024 4:36pm

@vercel Vercel
Copy link

vercel bot commented Nov 17, 2024

@zerod0t 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 Nov 17, 2024 •
edited
Loading

✅ Heimdall Review Status

Requirement Status More Info
Reviews ✅ 1/1
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 0
Sum 1

@cb-heimdall
Copy link
Collaborator

Review Error for ericbrown99 @ 2024-12-02 15:01:43 UTC
User failed mfa authentication, see go/mfa-help

@zerod0t
Copy link
Contributor Author

zerod0t commented Dec 3, 2024

@ericbrown99 Hi! Updated branch

@wbnns wbnns enabled auto-merge (squash) December 5, 2024 16:57
wbnns
wbnns approved these changes Dec 5, 2024
View reviewed changes
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.

ACK

@zerod0t Thanks for contributing and building on Base 🔵

@wbnns wbnns merged commit 9a0007f into base:master Dec 5, 2024
7 checks passed
EricNorberg pushed a commit to EricNorberg/web that referenced this pull request Dec 10, 2024
@zerod0t @EricNorberg
Various stylistic, grammatical and typographical errors in documentat…
2f1bc8d 
…ion (base#1260)

* Spelling and syntax errors

* Typo

* Spelling

* typo
chrischang pushed a commit to chrischang/web that referenced this pull request Jan 15, 2025
@zerod0t @chrischang
Various stylistic, grammatical and typographical errors in documentat…
7d90dc9 
…ion (base#1260)

* Spelling and syntax errors

* Typo

* Spelling

* typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wbnns wbnns wbnns approved these changes

@ericbrown99 ericbrown99 ericbrown99 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@zerod0t @cb-heimdall @wbnns @ericbrown99