ton-society / grants-and-bounties

TON Foundation invites talent to imagine and realize projects that have the potential to integrate with the daily lives of users.

Home Page:https://ton.org/grants

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Articles, improvements, reviews and fixes for TON docs

Gusarich opened this issue · comments

Summary

Part 1 (January 3):

Part 2 (June 3):

  • 28 Pull Requests (Reviews and Contributions):
    #112 (comment)
  • Many little fixes in direct commits

Context

Part 1 (January 3):

  • The article will be really helpful for developers - it explains the order of message delivery between smart contracts.
  • "Compile from Sources" has old and incomplete instructions for building
  • "Principles of a good tutorial" will help new contributors to write better articles and tutorials in docs
  • FAQ in fees article is incomplete
  • The FunC libraries list is empty
  • Web3 section is unstructured and missing new TON Storage articles
  • The documentation needs some little fixes such as replacing some old link with a new one, fixing images, adding some new tool/library in a list etc.

Part 2 (June 3):

  • The 28 Pull Requests encapsulate various improvements, including bug fixes, feature enhancements, and reviews. Each PR, whether large or small, contributes towards the overall betterment of the project.
  • The direct commits reflect an ongoing commitment to addressing smaller issues without going through the more formal PR process. These 'little fixes' help keep the documentation current, accurate, and user-friendly.

Goals

  • To continually improve the documentation and source code for increased usability and comprehension
  • To keep the project updated with the latest information, making it a reliable source of information for developers
  • To encourage the growth and participation of the community in the project through continuous improvements and openness to contributions.

Deliverables

  • Comprehensive articles that are consistently maintained with updates, improvements, and fixes
  • Continuous enhancement of the documentation through meticulous proofreading and minor corrections
  • Active participation in numerous Pull Request reviews

Definition of Done

  • Articles are merged and available in ton.org/docs
  • All improvements and fixes are merged and available in ton.org/docs

Reward

Part 1 (January 3):

  • Standard TON Footstep NFT
  • $500 in TON equivalent ($300 for the article, 5*30=$150 for 5 improvements, $50 for a bunch of fixes)

Part 2 (June 3):

  • $700 in TON equivalent ($500 for PR creation and reviews, $200 for many fixes and improvements in direct commits)

Total: $1200

I am writing to request the reopening of this issue. Since its closure, I have been steadfast in making significant improvements and fixes to our documentation. Over the past five months, I've either created or reviewed 28 pull requests with the ultimate goal of enhancing the clarity and quality of our documentation.

Below is a list of these pull requests. To ensure fairness, I have excluded those that were part of other Footsteps:

Each pull request serves as a testament to my unwavering commitment to improving our project's documentation. Additionally, there were numerous minor fixes incorporated through direct commits, which are not enumerated here. In light of the extensive work involved in these updates and improvements, I kindly request an appropriate reward for this ongoing contribution.

@reveloper, @SwiftAdviser, TON Documentation team, what do you think, how much are we will to pay for this job? How should we evaluate it?

@delovoyhomie I've updated the issue description, can you please look?
I'm asking for $700 for the improvements I made in past 5 months.

commented

@delovoyhomie based on provided history of articles, contributions, and Pull Requests reviews, I think @Gusarich, as one of the most active contributors and helpers, definitely can receive a retro-compensation for his outstanding activity.

The reward for the second stage has been paid. Thank you for the contribution.