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

[DOC] Improve docs on Workspaces #2324

Open
16 tasks
gagdiez opened this issue Nov 21, 2024 · 0 comments
Open
16 tasks

[DOC] Improve docs on Workspaces #2324

gagdiez opened this issue Nov 21, 2024 · 0 comments

Comments

@gagdiez
Copy link
Collaborator

gagdiez commented Nov 21, 2024

Documentation Type

Update Existing Documentation

What needs documentation?

I've got feedback that the current documentation on workspaces does not cover all relevant topics, and I have found this to be true when trying to use it myself.

We need to check the whole documentation and make sure we cover all relevant topics (see bellow)

Acceptance Criteria

The docs clearly state how to:

  • Create an account:
    • Using worker.dev-create-account
    • Using root.create_subaccount
    • Using Account::from_secret_key
    • Loading creadentials from the local disk
  • Deploy a contract in an account
    • Using worker.dev-deploy
    • Using account.deploy
  • Load a contract wasm:
    • Compiling the contract's code on the fly
    • Loading the byte wasm code from a file
  • Show contract's logs
  • Check an account's balance, explaining how users also expend money on gas
  • Spoon contract's from testnet or mainnet
  • Run tests on testnet
  • Make a view and a call, showing how to deserialize the result

Resources & References

No response

Priority

🔴 P0 : Missing Critical Documentation

@gagdiez gagdiez added this to DevRel Nov 21, 2024
@gagdiez gagdiez moved this to NEW❗ in DevRel Nov 21, 2024
@gagdiez gagdiez moved this from NEW❗ to In Progress 🏗️ in DevRel Nov 21, 2024
@gagdiez gagdiez moved this from In Progress 🏗️ to Backlog 🥶 in DevRel Nov 21, 2024
@gagdiez gagdiez removed the status in DevRel Nov 21, 2024
@gagdiez gagdiez moved this to NEW❗ in DevRel Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: NEW❗
Status: No status
Development

No branches or pull requests

2 participants