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

Various corrections in the documentation #5154

Merged
merged 89 commits into from
Jul 29, 2024
Merged

Various corrections in the documentation #5154

merged 89 commits into from
Jul 29, 2024

Conversation

rzadp
Copy link
Contributor

@rzadp rzadp commented Jul 26, 2024

An attempt to improve the docs by applying various corrections:

  • grammar/stylistics,
  • formatting,
  • broken links,
  • broken markdown table,
  • outdated vscode setting name,
  • typos,
  • consistency,
  • etc.

Part of paritytech/eng-automation#10

@rzadp rzadp added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels Jul 26, 2024
@rzadp rzadp requested a review from a team as a code owner July 26, 2024 13:35
@rzadp rzadp requested a review from kianenigma July 26, 2024 13:36
@@ -86,7 +86,7 @@
//!
//! Substrate-based runtimes use [`substrate_wasm_builder`] in their `build.rs` to automatically
//! build their WASM files as a part of normal build command (e.g. `cargo build`). Once built, the
//! wasm file is placed in `./target/{debug|release}/wbuild/{runtime_name}.wasm`.
//! wasm file is placed in `./target/{debug|release}/wbuild/{runtime_name}/{runtime_name}.wasm`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I was thinking, in here, should name a few tools that are useful for wasm build and testing. Do we still use srtools? If so, can you link it here please.

hoping to capture https://docs.substrate.io/build/build-a-deterministic-runtime/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we still use srtools? If so, can you link it here please.

Looks like yes, looking at runtime releases.

Screenshot 2024-07-26 at 18 43 35

I added a small note with a link to srtools.

Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

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

Thanks!

@rzadp rzadp enabled auto-merge July 29, 2024 09:15
@rzadp rzadp added this pull request to the merge queue Jul 29, 2024
Merged via the queue into master with commit de73c77 Jul 29, 2024
158 of 160 checks passed
@rzadp rzadp deleted the rzadp/docs branch July 29, 2024 14:10
TarekkMA pushed a commit to moonbeam-foundation/polkadot-sdk that referenced this pull request Aug 2, 2024
An attempt to improve [the
docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
by applying various corrections:

- grammar/stylistics,
- formatting,
- broken links,
- broken markdown table,
- outdated vscode setting name,
- typos,
- consistency,
- etc.

Part of paritytech/eng-automation#10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants