Open y04nqt opened 3 years ago
thanks @y04nqt for proposing this bounty. Do you have an estimation of the amount of work required in terms of number of hours?
i have read the docs, and yeah I do agree about the spelling mistakes and also there are some bugs in the code snippets as well, I can look after them, if you need my help, thanks
@gupadhyaya My estimate for the entire thing would take roughly 10-15 hours worth of work in total. I have the majority of copy done that would need to get pasted over the current copy. I have not yet published the incomplete work here to set this bounty up for ready to be worked on. I'll try to find time to update this bounty further to progress it along. @beingOptimusP Once I post the copy, you're more than welcome to look over it and add any additional fixes or details you have found that I didn't. :)
Consensus.edited.docx What Is Harmony Page.edited.docx transactions.docx Tokenomics.edited.docx Sharding.edited.docx Road Map , Strategy, and study materials.edited.docx Randomness.edited.docx key features.edited.docx faQ.edited.docx Effective Proof-of-Stake.edited.docx
All of these docs contain updated copy to their respective places in the docs. There's still more to be done, but this is what I have already gone through.
Description
The https://docs.harmony.one/home/ needs updating around grammar, spelling, and clarity. I will provide proofread copy per page and notes to make appropriate edits per page. The goal of this bounty is to make the harmony docs improved by bettering the overall grammatical copy to help instill trust into our developer community at large. Improving the docs with this easy lift will catch any erroneous or outdated text. We can also provide more context along the way where ideas need clarification.
Context
While I go through the docs, I figured I could at least provide updated spelling, grammar, and clarity checks to improve the documentation. I also believe having well-formed text helps build trust and faith in the brand. It shows we care about our public image and we care to provide clarity to our developer community. It should also help for translation to other languages used by translating services.
Acceptance Criteria
Reward
[amount of tokens in ONE] XYZ