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

Comprehensive TonSdk.NET Documentation #573

Open
5 tasks done
purpleguy99 opened this issue Apr 29, 2024 · 3 comments
Open
5 tasks done

Comprehensive TonSdk.NET Documentation #573

purpleguy99 opened this issue Apr 29, 2024 · 3 comments
Assignees
Labels
Approved This proposal is approved by the committee Education Related to educational resources or initiatives

Comments

@purpleguy99
Copy link
Contributor

purpleguy99 commented Apr 29, 2024

Summary

Creating detailed documentation for the use of TonSdk.NET based on previous bounty tasks along with popular use-cases, guides for comprehensive use.

Context

Why it's Important?

As the number of TON SDK developers increases daily, equipping them with comprehensive documentation that provides an understanding of various concepts and use-cases becomes imperative to facilitate the ease of use and expedite development. This documentation will function as a comprehensive guide to developers using tonsdk.net, significantly boosting their productivity and problem-solving abilities.

Presently, tonsdk.net serves numerous developers in executing various tasks, however, the absence of detailed documentation makes it difficult for the developer's community to understand and resolve issues independently. The increasing number of downloads indicate the popularity and wide usage of the SDK and hence the urgent need of a manual covering all main topics related to TON SDK, providing guidance and ways to troubleshoot common issues.

Learning goals

The solution involves creating detailed, user-friendly documentation for each module under tonsdk.net. This includes tonsdk.core, tonsdk.client, tonsdk.contracts, and tonsdk.connect. The inclusion of popular use cases, different guides, and ways to troubleshoot common issues will cater to the needs of the diverse TON SDK developer community.

References

#407
#276
#204

Estimate suggested reward

350$ in TON

Completion Criteria

Create docs base on all previous bounties with tonsdk.net. Will be implemented popular use-cases, guides and different ways to fix any issues using tonsdk.net.

  • create tonsdk.core docs (working with basic crypto classes, cells, addresses, coins etc)
  • create tonsdk.client docs (getting info about nft collection, jettons, wallet and dns)
  • create tonsdk.contracts docs (guides to work with wallet classes (deploying, transfering), jetton (minting, burn, transfer, create jettonminter), nft(deploy collection, transfer nft items)
  • create tonsdk.connect docs (guides to tonsdk.connect in backend apps and unity guide)
  • create popular use cases docs (different popular guides like sending tons, jettons, nfts, create and mint jettons and nfts)
@purpleguy99 purpleguy99 added the Education Related to educational resources or initiatives label Apr 29, 2024
@delovoyhomie delovoyhomie added the Approved This proposal is approved by the committee label Jun 14, 2024
@delovoyhomie
Copy link
Collaborator

@purpleguy99 thank you for the contribution!

To accurately recognize your valuable contributions in our repository, we kindly request you to submit a Pull Request to the Hall of Fame file, providing the wallet address and a link to the bounty with the number.

Please follow these steps:

  1. Fork the repository (if you haven't already).

  2. Edit the Hall of Fame file, commit, and push your changes.

  3. Create a Pull Request from your fork to the main repository, providing the wallet address and a link to the bounty with the number (for example, Pull Request Article: Generation of block random seed #136).
    For reference on what your entry should look like, please see the examples of past merged pull requests.

  4. And please follow the questbook proposal stage in accordance with the bounty guideline

@purpleguy99
Copy link
Contributor Author

purpleguy99 commented Aug 8, 2024

My wallet: matthewparker.ton
Docs page: https://docs.tonsdk.net/

@purpleguy99
Copy link
Contributor Author

#754

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved This proposal is approved by the committee Education Related to educational resources or initiatives
Projects
None yet
Development

No branches or pull requests

2 participants