-
Notifications
You must be signed in to change notification settings - Fork 389
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
docs: update How-to section with Playground #1766
Conversation
# Conflicts: # docs/how-to-guides/creating-grc20.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For creating-grc20.md: Nice:) Left some suggestions. For the text, primarily enhancements and to use imperative mode (to make it more instructional). For the realm, some nits
Latest preview of the docs: https://www.loom.com/share/e3e1bf4badcd4b7babb01cafe64ca799?sid=cc390952-e436-4b30-8ba2-1934cd8910ba |
# Conflicts: # docs/how-to-guides/testing-gno.md
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1766 +/- ##
=======================================
Coverage 47.74% 47.74%
=======================================
Files 393 393
Lines 61629 61629
=======================================
Hits 29424 29424
Misses 29734 29734
Partials 2471 2471 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about breaking down full packages or realms into smaller, more digestible parts, particularly for How-To guides. This means increasing the number of code blocks that gradually build up the realm to its final state. For instance, in the case of the grc20 How-To, we could sequentially introduce the main functions in separate code blocks, which would also allow us to divide the details listed at the end into more targeted sections, making the content more engaging and easier to follow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't agree with this route of porting all of our user documentation to use the Playground.
There should be clear instructions on how to work with gnokey
, especially specific actions like deployments and realm interactions.
I find great benefit in having documentation for the Playground present, just not as a replacement for existing tools we've built -- make sure we have them both incorporated
Status on this:
|
Description
This PR updates all tutorials in the How-to section of the docs to lead and primarily use the Playground as the number one option to write Gno code.
I also fixed minor issues and updated outdated code along the way.
For all of the snippets of code shared via the Playground links, there is a unique comment at the bottom of the code, such as
// How to: Deploy using Gno Playground
, so that deployments can be traceable via metrics.This PR also removes the GRC721 guide because GRC721 needs refactoring and is not very usable right now.
Latest preview of the docs: #1766 (comment)
cc @ilgooz @salmad3
Contributors' checklist...
BREAKING CHANGE: xxx
message was included in the description