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

TACT lang documentation. #105

Closed
18 tasks done
reveloper opened this issue Dec 25, 2022 · 10 comments
Closed
18 tasks done

TACT lang documentation. #105

reveloper opened this issue Dec 25, 2022 · 10 comments
Assignees
Labels
Approved This proposal is approved by the committee footstep This is a TON Footstep issue

Comments

@reveloper
Copy link
Contributor

reveloper commented Dec 25, 2022

Summary

Create detailed and friendly Tact documentation in the new section of ton.org/documents.

Context

Tact is a scalable and safe language to build smart contracts for TON. Documentation for Tact should help to simplify the process of onboarding developers.

Goals

  • Implement core documentation to help newcomers onboard in TON development via TACT language.

  • Current footstep covers the following things:

    • Creating core documentation structure defined by a detailed table of content.
    • Set up environment materials for at least one platform and IDE.
    • Tutorial for creating and deploying basic smart contracts(Wallet, Jetton, Multisig).
    • Thinking about developing in TON in the context of TACT language(For example, transferring concepts from FunC materials and adding new actual thoughts).
    • Description of the core language entities(statements, functions, contracts).
    • Standard library overview and description.
    • TACT syntax highlights integrate as soon, as somebody implements this.

Deliverables

As a result, we should get documentation, that kick-off other developers to use Tact and help to improve documentation and language faster.

Definition of Done

First week

  • TACT lang overview article.
  • Set up the environment Article for 1 Operation system and 1 IDE(Detailed guide in Tact Hello World guide).
  • Smart contract implementation and deploying guide article I. (Step-by-step guide with Increment contract).
  • Basic syntax overview article.

Second week
x TACT Concepts. Types definition with one code block for each.

  • Standard functions
  • Smart contract implementation and deploying guide article II. (Wallet.tact contract demo guide. How to deploy via public endpoints. ).
  • Basic syntax.

Third week

  • Concepts/Basic types.
  • Concepts/Primitive types.
  • Concepts/High-level types.
  • Smart contract implementation and deploying guide Article III. (Jetton.tact contract. Deployment contract and explanation of Jetton design).

Fourth week

  • Tact Cookbook. (Template and footsteps created)
  • Basic concept of developing smart contract in TON via Tact lang. (page template added)
    x Guidelines on the code style and code organization.

Fifth week

  • Public launch of documentation.
  • Collect feedback from the Ton developers community.
  • Fix small typos and requests based on comments.
  • Create new issues and footsteps for new contributors based on the most relevant problems for Tact.

Reward

  • 4000 (3500 + 500) USD equivalent in TON.

Total: $4000

@reveloper reveloper added the footstep This is a TON Footstep issue label Dec 25, 2022
@howardpen9
Copy link

LFG

@reveloper
Copy link
Contributor Author

Footstep is currently in the review stage, so before start implementing this, we should clarify the footstep description including the content table of documents and the directory where it will be placed.
It seems it will be in the review stage at least until January 1st, because of the x-mas holidays.

@Hiyorimi
Copy link
Contributor

LGTM

@Hiyorimi Hiyorimi added the Approved This proposal is approved by the committee label Jan 3, 2023
@reveloper
Copy link
Contributor Author

Work in progress.

@reveloper
Copy link
Contributor Author

reveloper commented Jan 30, 2023

@Hiyorimi I'm stuck on the jetton demo project and article step. It looks clear to me now, what needs to finish in this example(need fix for this issue) and finish the guide in a day, but I spent two weeks only on this step instead of the planned one week.
I want to decrease the value of content for 4th week, and transfer what will be possible in the fifth week.
It means, that the public launch in 2 days will introduce all content in 1-3 weeks(including Jetton), and will not contain what was planned for 4th week:

  • Tact Cookbook.
  • Basic concept of developing smart contract in TON via Tact lang.
  • Guidelines on the code style and code organization.

It will be fair if you want to decrease the reward correspondingly, my wish is to finish work by the deadline, and don't to stretch out the footstep in months.

@reveloper
Copy link
Contributor Author

I launched public tests of Tact documentation on 04.02.23 on ton.org, but it was deleted from there without any comments. Because of that, I have no opportunity to continue following the steps: collecting feedback and fixing issues according to the footstep plan.

Please, help me solve this issue ASAP.

@reveloper
Copy link
Contributor Author

reveloper commented Feb 7, 2023

I finished my job with documentation - PR

The main part was finished and released in TON Docs on 04.02.23 - original price - 3500$ in TON

Because documentation was an additional request to transfer to https://docs.tact-lang.org/ a had to adapt the whole content to a new platform and it takes additional 30hrs.
Would it be fair to pay for this additional job according to the standard price of my job?

My hourly rate is:
3000$/month ≈ 18.75$/hour -> 500$ in a TON.

I will continue to support small issues/creating footsteps during the next month according to the current footstep.

My TON wallet: EQCFv_2OqxdVm4IFOps-XCkW6xeug49b9FTyk8fbI-cIumAF

@delovoyhomie
Copy link
Collaborator

If you're done, create a PR to the hall of fame

@delovoyhomie
Copy link
Collaborator

@reveloper, everything is OK? It remains to create a Pull Request to complete

@reveloper
Copy link
Contributor Author

@delovoyhomie Done. #147

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 footstep This is a TON Footstep issue
Projects
None yet
Development

No branches or pull requests

4 participants