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

TVM Instruction Search React Component for TON Docs #175

Closed
SwiftAdviser opened this issue Mar 9, 2023 · 3 comments · Fixed by ton-community/ton-docs#198 or #192
Closed

TVM Instruction Search React Component for TON Docs #175

SwiftAdviser opened this issue Mar 9, 2023 · 3 comments · Fixed by ton-community/ton-docs#198 or #192
Assignees
Labels
Approved This proposal is approved by the committee footstep This is a TON Footstep issue

Comments

@SwiftAdviser
Copy link
Contributor

SwiftAdviser commented Mar 9, 2023

Summary

The TVM Instruction Search React Component is a project that aims to improve the accessibility and usability of information about TVM instructions, which is currently provided in tables on the TON Documentation website.

This project will create a new React component that can be integrated into the website, allowing users to search for TVM instruction information based on opcode, rather than having to manually search through multiple tables.

Context

image

The TON Documentation website provides a list of TVM instructions, along with their opcodes, in the form of multiple tables. However, this method of presenting the information can be difficult and time-consuming to navigate, especially for users who are not familiar with the TVM instruction set.

As a result, users may struggle to find the information they need, which can impact their ability to effectively use the TON network.

Goals

The goal of this project is to improve the user experience of the TON Documentation website by creating a new React component that allows users to easily search for information about TVM instructions based on opcode.

By providing a more user-friendly and efficient search process, the project aims to increase the accessibility and usability of TVM instruction information, helping users to better understand and utilize the TON network.

Deliverables

  1. A fully functional TVM search React component integrated into the TON Documentation website (TON Docs based on Docusaurus)

Definition of Done

  1. The React component is fully functional and allows users to search for TVM instruction information based on opcode (or part of it)
  2. The search results display the Fift syntax, Stack, Description, and Gas for the relevant TVM instruction (current info from the tables)
  3. The React component is integrated into the TVM Instructions page of the TON Documentation website, replacing the existing tables into the Archive

Reward

  • Standard TON Footsteps SBT NFT
  • 600 USD in TON

Total: $600

@SwiftAdviser SwiftAdviser added the footstep This is a TON Footstep issue label Mar 9, 2023
@murluki
Copy link

murluki commented Mar 11, 2023

@SwiftAdviser Hello, could you please assign it to me?
Thank you very much

@delovoyhomie delovoyhomie added the Approved This proposal is approved by the committee label Mar 14, 2023
@delovoyhomie
Copy link
Collaborator

@murluki, we discussed and decided that it's worth assigning one person to one footstep so that the work is done well without haste. In your case, we're leaving you to complete Footstep #173. If you complete your footstep (#173) and no one else takes it, it's yours.

@krau5 is ready to complete this footstep. His vision is very good. Are you ready?

@krau5
Copy link
Contributor

krau5 commented Mar 15, 2023

@delovoyhomie yep, I would like to work on this footstep, you can assign it to me

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
4 participants