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

Re-write "Compatibility with FunC" page of the Book #1145

Open
novusnota opened this issue Mar 14, 2024 · 1 comment
Open

Re-write "Compatibility with FunC" page of the Book #1145

novusnota opened this issue Mar 14, 2024 · 1 comment
Assignees
Labels
bug Something isn't working or isn't right docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs.tact-lang.org Documentation for docs.tact-lang.org kept in docs folder func

Comments

@novusnota
Copy link
Member

novusnota commented Mar 14, 2024

In particular:

  1. Poor formatting
  2. Incomplete examples
  3. Exit codes (explain the concept to later be defined by Re-write exit-codes.mdx into an article of the Book #887)
  4. Lack of serialization options and details, see Document as bytes32 and as bytes64 #1178 and Document as remaining tact-docs#26

In general, this page and all of the other means for smooth transitioning from FunC to Tact and approaches for integrating existing FunC code to Tact is very important going forward.

Therefore, this page should cover two aspects:

  1. Tapping into existing FunC code from Tact — the main focus of this page, for general list of users.
  2. Converting FunC code to Tact — for more advanced users. For the most part, this should be covered in "Coming from FunC" page #1130.

Once done, correct existing #-links to that page and add new ones to the appropriate places of the Book

UPD:
Actually, it should just become a part of description for native functions and have its own page similar to upcoming "assembly functions page". There, we'll describe everything people would need or ask when binding to existing FunC code from Tact, plus reference that from the "import code" page.

As for the aspect of converting the FunC code to Tact, it should be covered in #1130.

@novusnota novusnota added bug Something isn't working or isn't right docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials labels Mar 14, 2024
@novusnota novusnota self-assigned this Mar 17, 2024
@novusnota
Copy link
Member Author

Actually, it should just become a part of description for native functions and have its own page similar to upcoming "assembly functions page". There, we'll describe everything people would need or ask when binding to existing FunC code from Tact, plus reference that from the "import code" page.

As for the aspect of converting the FunC code to Tact, it should be covered in #1130.

@anton-trunov anton-trunov transferred this issue from tact-lang/tact-docs Dec 12, 2024
@anton-trunov anton-trunov added the docs.tact-lang.org Documentation for docs.tact-lang.org kept in docs folder label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working or isn't right docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs.tact-lang.org Documentation for docs.tact-lang.org kept in docs folder func
Projects
None yet
Development

No branches or pull requests

2 participants