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

Detailed description of TON block layout in the TON Documentation. #201

Closed
4 tasks done
reveloper opened this issue Apr 5, 2023 · 13 comments
Closed
4 tasks done
Assignees
Labels
Approved This proposal is approved by the committee footstep This is a TON Footstep issue

Comments

@reveloper
Copy link
Contributor

reveloper commented Apr 5, 2023

Summary

Create a detailed description of the Block layout in TON. The current reference is the original TON Blockchain document, which needs to be transferred to docs.ton.org and verified for the current implementation. We also want to improve readability.

Context

Need to create a new page or section "Block Layout" in the Data Formats section and transfer there all actual knowledge TON Blockchain document.

How to contribute to TON Documentation?

Goals

  1. To create a detailed and accurate description of the TON block layout that is up-to-date and easy to understand. It will be helpful to include a graphic explanation to further clarify its structure.
  2. This page(section of docs) is primarily intended for documentation purposes and not as a tutorial, so it is important to minimize the use of personal examples or analogies in the text. It is crucial to ensure that the content is suitable for both professionals and non-professionals alike, while still providing valuable information.
  3. If a concept was written in TON Blockchain document but is not yet production-ready for the current TON Blockchain, ensure it is clearly marked with a special label or information bar to avoid confusion.
  4. All references to Block Layout in the TON Blockchain should be redirected to the new Block Layout section in docs.ton.org. (For instance, this link)

Deliverables

  • References to possibly outdated documentation are excluded
  • The best explanation for beginners
  • All basic information is gathered in one platform and can be found using Search

Definition of Done

  • New page(section) Block Layout created with PR to docs.ton.org Data Formats section
  • Block Layout actual implementation corresponds to created documentation
  • Links to Block Layout redirected within docs.ton.org
  • PR Reviewed and merged

Oriental Release Date

TBD

Reward

  • 500$ in TON equivalent
  • Standard TON Footstep NFT

Total: $500

@reveloper reveloper added the footstep This is a TON Footstep issue label Apr 5, 2023
@Gusarich
Copy link
Contributor

Gusarich commented Apr 6, 2023

LGTM

@Gusarich Gusarich added the Approved This proposal is approved by the committee label Apr 6, 2023
@delovoyhomie
Copy link
Collaborator

@reveloper, what footstep are you going to do on: #202 or #201?

@reveloper
Copy link
Contributor Author

reveloper commented Apr 7, 2023

For footsteps(#201, #202, #196) I hope to find new participants who can take on these tasks.

@cyberiagod
Copy link

I'm ready to do this footstep

@delovoyhomie
Copy link
Collaborator

@cyberiagod, we assign one person to one footstep to optimize. Start with #201. If you’re done and no one takes #202, it’s yours. Take your time, the main thing in the work is quality!

@delovoyhomie
Copy link
Collaborator

Also don't forget to write here sometimes about your current progress.

@cyberiagod
Copy link

@cyberiagod, we assign one person to one footstep to optimize. Start with #201. If you’re done and no one takes #202, it’s yours. Take your time, the main thing in the work is quality!

ok

@cyberiagod
Copy link

@cyberiagod, we assign one person to one footstep to optimize. Start with #201. If you’re done and no one takes #202, it’s yours. Take your time, the main thing in the work is quality!

ok

done

@delovoyhomie
Copy link
Collaborator

@cyberiagod, great! Attach a link to PR in TON Docs and create a PR to Hall of Fame.

@delovoyhomie
Copy link
Collaborator

@cyberiagod, we decided to reconsider the completion process and now there is no need to create PR to Hall of Fame (#212)

If you done this Footstep, just write your wallet for a reward.

@reveloper
Copy link
Contributor Author

@delovoyhomie, unfortunately, it looks like we have lost connection with @cyberiagod. In light of this, I think that we should unsign the current assignee from this Footstep.

@Gusarich
Copy link
Contributor

Done in PR:

Wallet for reward:
EQBKgXCNLPexWhs2L79kiARR1phGH1LwXxRbNsCFF9doc2lN

@delovoyhomie
Copy link
Collaborator

Rewards sent! Thank you for the contribution.

Gusarich added a commit that referenced this issue May 24, 2023
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