-
Notifications
You must be signed in to change notification settings - Fork 272
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
Add subwasm guide #503
Add subwasm guide #503
Conversation
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.
This is great! Although before merge, I highly suggest a few tweaks.
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.
some suggestions.
## Before you begin | ||
|
||
To follow this guide you should have a runtime from a chain you wish to query. | ||
This could either be one running locally or one running in production. |
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.
This could either be one running locally or one running in production. | |
This could either be one running locally or one running in production. |
I'd append this to the previous sentence "...query running locally or in production."
or clarify the subject (avoid starting sentences with the ambiguous This without a noun):
The runtime can be running on a local node or in production.
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.
To avoid confusion, I took this sentence out. The previous one states that the prerequisite is to have a chain running locally. Don't think it makes sense to specify that the user of this guide needs to be ready to use a chain in production - there's not much preparation needed there.
Co-authored-by: Lisa Gunn <[email protected]>
Co-authored-by: Lisa Gunn <[email protected]>
Co-authored-by: Lisa Gunn <[email protected]>
Co-authored-by: Eve-Parity <[email protected]>
## Before you begin | ||
|
||
To follow this guide you should have a runtime from a chain you wish to query. | ||
This could either be one running locally or one running in production. |
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.
To avoid confusion, I took this sentence out. The previous one states that the prerequisite is to have a chain running locally. Don't think it makes sense to specify that the user of this guide needs to be ready to use a chain in production - there's not much preparation needed there.
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.
Had one suggestion
Co-authored-by: Eve-Parity <[email protected]>
Initially planned to pack a couple tooling guides here but for now this covers Subwasm basics.
Open to ideas on adding or modifying current content. Tricky to reference any specific examples for this one because this is a tool that creates files to be checked locally.