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

Suggestion: "Tutorial" #155

Open
dakom opened this issue Sep 12, 2024 · 4 comments
Open

Suggestion: "Tutorial" #155

dakom opened this issue Sep 12, 2024 · 4 comments

Comments

@dakom
Copy link
Contributor

dakom commented Sep 12, 2024

The current docs structure is excellent for someone who is working with CosmWasm and needs to look up a specific topic (e.g. how to work with wasmd, storey, add ibc hooks, etc.), or someone brand-new to CosmWasm and wants a tour of everything it can do.

However, we received a couple comments - and I agree, that it's not very clear from a "how to get started, hands-on" perspective.

What about a separate section called "Tutorial" that is a start-to-finish guide with to create a contract, deploy it, test it, etc.?

Where applicable, it can show examples with different tools in tabs (like the "Containers" section in Storey showing storage-plus vs. Story: https://docs.cosmwasm.com/storey/containers)

@jawoznia
Copy link
Contributor

I agree. I created the #111 issue for that as I also am missing the actual usage of CosmWasm. It's good that the documentation is atomized to the semantical parts, but we are missing the bigger picture of how to use our product.

@jawoznia
Copy link
Contributor

I have been thinking about it and we could make a section Examples in the docs. There we could through simple contracts like Counter, two contracts communicating, usage of CustomQuery and CustomMsg, and so on.

We could then for one of them present the full path from creation through deployment to communication with the contract stored on the chain.

@hashedone
Copy link
Collaborator

What do you think about starting with moving the book (https://book.cosmwasm.com/, https://cosmwasm.github.io/sylvia-book/index.html) to the docs portal? Maybe not copy-paste, but refresh it in the process. It was written with such an approach in mind.

@kulikthebird
Copy link

Yep, it would be good to have single source of truth. Easier to maintain for us, better for users to look for info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants