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

Various stylistic, grammatical and typographical errors in documentation #1260

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

Conversation

zerod0t
Copy link

@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?

Copy link

vercel bot commented Nov 17, 2024

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

Name Status Preview Comments Updated (UTC)
web-base-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 29, 2024 0:26am

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

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/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

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.

2 participants