halogrants icon indicating copy to clipboard operation
halogrants copied to clipboard

Published 20 hours ago • verified publisher icon iotexproject

Review and improve IoTeX Docs

Open simonerom opened this issue 3 years ago • 7 comments

Discuss: Please join our Discord Dev Chat to ask any questions or reach out to Simone_IoTeX on Discord if you need any help.

Follow Us: iotex.io | Telegram | Twitter | Medium | Reddit

Bounty Description

We would like you to go through our documentation website at https://docs.iotex.io from a User/developer perspective and provide a report pointing out errors, inconsistencies, typos, dead links. Also go through the examples and tutorials and try them reporting what is not working, errors, outdated content etc...

Acceptance criteria

  • [ ] Read carefully through every single section and try out all instructions to make sure there is no confusing content.
  • [ ] Report as many issues as possible in your report
  • [ ] If you have any, please report any suggestions about how you would improve the content

Milestone 1

  • [ ] Provide a report with the list of relevant things to change/improve: for each item provide at least
    • a screenshot of the relevant doc section
    • the actual link to get there
    • your notes about what's wrong/how to improve

Reward

  • [ ] Milestone I: $500-$2000 equivalent in IOTX tokens based on the quality of issues and suggestions provided.

simonerom avatar May 20 '21 16:05 simonerom

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 15505.8593 IOTX (498.59 USD @ $0.03/IOTX) attached to it as part of the iotexproject fund.

gitcoinbot avatar May 20 '21 20:05 gitcoinbot

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work has been started.

These users each claimed they can complete the work by 265 years, 5 months from now. Please review their action plans below:

1) ries9112 has started work.

I am working on going through the entire documentation in the next three days and reporting anything that I find to be confusing or problematic. I have extensive experience writing documentation both professionally and for open source, and I use my own knowledge as a developer to assess how viable cryptocurrency projects are by doing the quick-start examples from the documentation. I am very detail oriented and I am confident I can help with this, really looking forward to help improve the documentation for this project. 2) nightwolf3 has started work.

as discussed on discord, I have good experience in technical documentation as well as ethereum development 3) mwood77 has started work.

Hi Simone & IoTeX, I reached out to you over discord today. I'll keep you up to date with how I progress. Chat again soon. 4) whoamimrxx has started work.

Irei prestar atenção aos mínimos detalhes do arquivo em si para melhor precisão! 5) khaliq7866 has started work.

Can You Tell Me About Staking Program....? 6) em-ghub2020 has started work.

i will put to play my research skills and come up with the best content. 7) nagibraik has started work.

I have experience working with the trading platforms and the smart contracts,and I think this is a great projet to start working on and developing a different strategies. 8) iamochuko has started work.

I'll read the docs; take note of possible typos, evaluate provided sample codes for expected result and submit a report with acceptance criteria with recommendations if need be. 9) oneman299 has started work.

Read every section of Iotex documentation Check data consistency Check for spelling and grammatical mistakes or errors

Write a report detailing the sections requiring correction with screenshots and links.

Learn more on the Gitcoin Issue Details page.

gitcoinbot avatar May 23 '21 08:05 gitcoinbot

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 15505.8593 IOTX (500.54 USD @ $0.03/IOTX) has been submitted by:

gitcoinbot avatar May 27 '21 13:05 gitcoinbot

@gitcoinbot didn't quote me correctly for my work submitted. Hence I'm posting here.

Work: https://github.com/mwood77/IoTeX/tree/1.0.0 Task: https://gitcoin.co/issue/iotexproject/halogrants/32/100025753

Screenshot 2021-05-27 at 15 23 08

mwood77 avatar May 27 '21 13:05 mwood77

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

Work for 15505.8593 IOTX (455.03 USD @ $0.03/IOTX) has been submitted by:

  1. @mwood77
  2. @nagibraik

@simonerom please take a look at the submitted work:

  • PR by @nagibraik
  • PR by @mwood77

gitcoinbot avatar May 28 '21 18:05 gitcoinbot

Just submitted my work.

Here is my GitHub repository for the task: https://github.com/ries9112/IoTeX-Documentation-Review

And you can find my documentation/review here: https://ries9112.github.io/IoTeX-Documentation-Review/

Using the link above you should see a document like this with my complete review of all sections: image

ries9112 avatar May 30 '21 00:05 ries9112

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

The funding of 1500.0 USDT (1500.00 USD @ $1.0/USDT) attached to this issue has been approved & issued to @mwood77.

gitcoinbot avatar Jun 18 '21 15:06 gitcoinbot