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

[Contract examples] Review examples documentation #1534

Open
4 tasks
claytonneal opened this issue Nov 25, 2024 · 0 comments
Open
4 tasks

[Contract examples] Review examples documentation #1534

claytonneal opened this issue Nov 25, 2024 · 0 comments

Comments

@claytonneal
Copy link
Member

claytonneal commented Nov 25, 2024

Let's review the contract examples and transaction examples
Specifically, the contract-function-call example which doesn't actually call the contract.
But not only, every improvement is welcome.

Acceptance criteria

  • Add a readme in the docs/examples root to explain how the examples are organized
  • Add a header to each example ts file, feel free to use AI to autogenerate (but review)
  • Have a code snippet for each of the atomic features provided by the SDK (either as runnable examples or in the FAQ)
  • Make sure the examples available in docs.vechain.org are injested/generated from the full examples available here
@claytonneal claytonneal changed the title [Contract examples] The only show creating a clause [Contract examples] Review examples Nov 25, 2024
@victhorbi victhorbi changed the title [Contract examples] Review examples [Contract examples] Review examples documentation Nov 28, 2024
@victhorbi victhorbi added this to the Documentation milestone Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants