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

Add subwasm guide #503

Merged
merged 22 commits into from
Nov 26, 2021
Merged

Add subwasm guide #503

merged 22 commits into from
Nov 26, 2021

Conversation

sacha-l
Copy link

@sacha-l sacha-l commented Nov 8, 2021

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.

@sacha-l sacha-l temporarily deployed to test November 8, 2021 14:42 Inactive
@sacha-l sacha-l changed the title New tools guides New guides: subwasm Nov 8, 2021
@sacha-l sacha-l temporarily deployed to test November 8, 2021 14:49 Inactive
@sacha-l sacha-l temporarily deployed to test November 10, 2021 21:21 Inactive
@sacha-l sacha-l temporarily deployed to test November 10, 2021 21:26 Inactive
@sacha-l sacha-l temporarily deployed to test November 11, 2021 08:58 Inactive
@sacha-l sacha-l changed the title New guides: subwasm Add subwasm guide Nov 11, 2021
@sacha-l sacha-l marked this pull request as ready for review November 11, 2021 09:02
@sacha-l sacha-l temporarily deployed to test November 11, 2021 09:05 Inactive
Copy link
Contributor

@nuke-web3 nuke-web3 left a 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.

Copy link
Contributor

@lsgunnlsgunn lsgunnlsgunn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some suggestions.

v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Author

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.

v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:09 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:14 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:40 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:40 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:40 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:41 Inactive
## 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.
Copy link
Author

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.

v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:43 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:43 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 09:49 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 10:00 Inactive
@sacha-l sacha-l temporarily deployed to test November 22, 2021 10:05 Inactive
Copy link

@Eve-Parity Eve-Parity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had one suggestion

v3/how-to-guides/08-tools/d-subwasm/index.mdx Outdated Show resolved Hide resolved
@sacha-l sacha-l temporarily deployed to test November 26, 2021 09:41 Inactive
@sacha-l sacha-l temporarily deployed to test November 26, 2021 09:47 Inactive
@sacha-l sacha-l temporarily deployed to test November 26, 2021 09:48 Inactive
@sacha-l sacha-l temporarily deployed to test November 26, 2021 09:53 Inactive
@sacha-l sacha-l merged commit 03fcc5d into main Nov 26, 2021
@sacha-l sacha-l deleted the sl/new-tools-guides branch November 26, 2021 10:01
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

Successfully merging this pull request may close these issues.

4 participants