ObolNetwork / ObolNetwork/obol-docs

docs: serious grammar and spelling errors

Open
#432 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
27
Forks
61
Avg merge
1h 22m
Merged PRs (30d)
2

Description

🎯 Problem to be solved

The current documentation contains grammatical and spelling errors, as well as typos, which may hinder understanding and reduce the overall quality of the documentation. It is important to correct these errors to improve clarity and professionalism. Closes #431

  • Link to the codebase issue that prompted this docs change

🛠️ Proposed solution

Implement corrections in the documentation to eliminate the identified grammatical and spelling errors. This includes:

  1. Correcting typos and misspelled words.

  2. Fixing grammatical errors such as incorrect verb tenses, missing articles, and punctuation mistakes.

  3. Enhancing sentence structure for better clarity.

  • For major overhaul of docs, design doc link:

🧪 Tests

  • Netlify deployment build tests passing

👐 Additional acceptance criteria

❌ Out of Scope

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No documentation files or specific error locations are named, so first inspect the repository’s docs content to identify the affected pages and corrections needed. Run the Netlify deployment build after editing; done means the identified spelling, grammar, punctuation, and clarity issues are corrected without breaking the documentation build.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.