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

feat(docs): Add Typescript SDK examples #3566

Merged
merged 18 commits into from
Nov 8, 2024
Merged

Conversation

nonast
Copy link
Contributor

@nonast nonast commented Oct 23, 2024

Description of change

This PR contains the typescript equivalents of the rust sdk examples. The purpose of this PR is to receive preliminary feedback on the current typescript examples, to ensure it aligns with best practices for the rest of the examples belonging to this issue.

Links to any relevant issues

fixes #3176

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Documentation Fix

How the change has been tested

Describe the tests that you ran to verify your changes.

Make sure to provide instructions for the maintainer as well as any relevant configurations.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@miker83z miker83z requested a review from a team October 23, 2024 07:06
@nonast nonast self-assigned this Oct 23, 2024
@nonast nonast added sc-platform Issues related to the Smart Contract Platform group. vm-language Issues related to the VM & Language Team labels Oct 23, 2024
@nonast nonast changed the title Vm language/examples feat(docs): Vm language/examples Oct 23, 2024
@nonast nonast changed the title feat(docs): Vm language/examples feat(docs): VM language/examples Oct 23, 2024
@nonast nonast changed the title feat(docs): VM language/examples feat(docs): Add Typescript SDK examples Oct 23, 2024
@miker83z miker83z marked this pull request as ready for review October 30, 2024 09:42
@miker83z miker83z requested a review from a team as a code owner October 30, 2024 09:42
@miker83z miker83z requested a review from a team October 30, 2024 09:45
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lzpap
Copy link
Member

lzpap commented Oct 30, 2024

Could you already import the examples into the docs pages where the code snippets are already there for the Rust side?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 30, 2024
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@miker83z miker83z requested a review from a team October 30, 2024 17:25
Copy link
Contributor

@miker83z miker83z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls, check that all inline comments in the TS code are similar to the Rust code. I only highlighted the address-unlock-condition ones.

Copy link
Contributor

github-actions bot commented Nov 6, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Nov 7, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Nov 7, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@nonast nonast force-pushed the vm-language/examples branch from 0de4d2b to 1e1c0db Compare November 8, 2024 06:53
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@nonast nonast merged commit f59220d into develop Nov 8, 2024
38 of 41 checks passed
@nonast nonast deleted the vm-language/examples branch November 8, 2024 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation sc-platform Issues related to the Smart Contract Platform group. vm-language Issues related to the VM & Language Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs/move] Audit Stardust Move models after re-fork and complete documentation
6 participants