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 Transaction layout in the TON Documentation. #202

Closed
4 tasks done
reveloper opened this issue Apr 6, 2023 · 4 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 6, 2023

Summary

Create a new section Transaction Layout and fill this with verified knowledge from TON Blockchain. Documentation should be verified for the current implementation in TON. We also want to improve readability.

Context

Currently, we refer to information about Transaction in TON in TON Blockchain Document

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

How to contribute to TON Documentation?

Goals

  1. To create a detailed and accurate description of the TON Transaction that is up-to-date and easy to understand. It will be helpful to include a graphic explanation to further clarify its structure and processes.
  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 Transaction in the TON Blockchain should be redirected to the new Transaction 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) Transaction Layout created with PR to docs.ton.org Data Formats section.
  • Transaction Layout actual implementation corresponds to created documentation
  • Links to Transaction 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 6, 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
@cyberiagod
Copy link

I'm ready to do this footstep

@Gusarich
Copy link
Contributor

Gusarich commented May 19, 2023

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