diff --git a/.netlify/_redirects b/.netlify/_redirects index afda3f68c..3aee51a1c 100644 --- a/.netlify/_redirects +++ b/.netlify/_redirects @@ -1,6 +1,6 @@ # Redirects from what the browser requests to what we serve -/rustdocs https://paritytech.github.io/substrate/master/sc_service/ 301! +/rustdocs https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html 301! /how-to-guides /reference/ 301! diff --git a/README.md b/README.md index e8bcd06e2..d55cbc7b1 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,6 @@ Default localhost port configuration: ```env GATSBY_WEBSITE_URL=http://localhost:8100 GATSBY_DOCS_URL=http://localhost:8200 -GATSBY_MARKETPLACE_URL=http://localhost:8300 -GATSBY_CAREERS_URL=https://careers.substrate.io ``` **Start development server** diff --git a/config/menus.js b/config/menus.js index 38f84a0a5..9bde95b39 100644 --- a/config/menus.js +++ b/config/menus.js @@ -1,4 +1,4 @@ -const { MARKETPLACE_URL, WEBSITE_URL, CAREERS_URL } = require('./webConsts.js'); +const { WEBSITE_URL } = require('./webConsts.js'); /* the main menu, ids of items must match the submenu's key of this js object */ @@ -58,10 +58,6 @@ const developers = [ url: 'https://paritytech.github.io/substrate/master/sc_service/', id: 'developers.rustdocs', }, - { - url: MARKETPLACE_URL, - id: 'developers.marketplace', - }, { url: WEBSITE_URL + '/developers/smart-contracts/', id: 'developers.smart-contracts', @@ -128,10 +124,6 @@ const opportunities = [ url: WEBSITE_URL + '/ecosystem/opportunities/grants', id: 'ecosystem.opportunities.grants', }, - { - url: CAREERS_URL, - id: 'ecosystem.opportunities.careers', - }, ]; const resources = [ diff --git a/config/siteMetadata.js b/config/siteMetadata.js index 6b2ca8a85..9e090d5b3 100644 --- a/config/siteMetadata.js +++ b/config/siteMetadata.js @@ -1,5 +1,5 @@ const menus = require('./menus.js'); -const { WEBSITE_URL, DOCS_URL, MARKETPLACE_URL, CAREERS_URL } = require('./webConsts.js'); +const { WEBSITE_URL, DOCS_URL } = require('./webConsts.js'); module.exports = { menus, @@ -10,8 +10,6 @@ module.exports = { siteUrl: DOCS_URL, websiteUrl: WEBSITE_URL, docsUrl: DOCS_URL, - marketplaceUrl: MARKETPLACE_URL, - careersUrl: CAREERS_URL, author: 'Parity WebDev/W3F WebOps', pressEmail: 'press@parity.io', email: 'info@parity.io', diff --git a/config/webConsts.js b/config/webConsts.js index 577ba7830..014af96c5 100644 --- a/config/webConsts.js +++ b/config/webConsts.js @@ -1,11 +1,7 @@ const WEBSITE_URL = process.env.GATSBY_WEBSITE_URL; const DOCS_URL = process.env.GATSBY_DOCS_URL; -const MARKETPLACE_URL = process.env.GATSBY_MARKETPLACE_URL; -const CAREERS_URL = process.env.GATSBY_CAREERS_URL; module.exports = { WEBSITE_URL, DOCS_URL, - MARKETPLACE_URL, - CAREERS_URL, }; diff --git a/content/config/nav.yaml b/content/config/nav.yaml index 699a0cb11..27dfe9277 100644 --- a/content/config/nav.yaml +++ b/content/config/nav.yaml @@ -1,4 +1,5 @@ menu: + - polkadot-sdk - quick-start - learn - install @@ -10,6 +11,10 @@ menu: - reference - community +polkadot-sdk: + title: Substrate to Polkadot SDK + url: /polkadot-sdk/ + quick-start: title: Quick start url: /quick-start/ @@ -84,7 +89,7 @@ install: url: /install/developer-tools/ - title: Troubleshoot Rust issues url: /install/troubleshoot-rust-issues/ - + #design: # title: Design # url: /design/ @@ -156,7 +161,7 @@ test: url: /test/simulate-parachains/ - title: Check runtime url: /test/check-runtime/ - + deploy: title: Deploy url: /deploy/ diff --git a/content/locales/en/menus.json b/content/locales/en/menus.json index c0997a77c..2e668276f 100644 --- a/content/locales/en/menus.json +++ b/content/locales/en/menus.json @@ -14,7 +14,6 @@ "developers.home": "Home", "developers.docs": "Docs", "developers.rustdocs": "Rust Docs", - "developers.marketplace": "Marketplace", "developers.smart-contracts": "Smart Contracts", "developers.substrate-connect": "Substrate Connect", "developers.rococo-network": "Rococo Network", @@ -31,7 +30,6 @@ "ecosystem.opportunities.hackathons": "Hackathons", "ecosystem.opportunities.grants": "Grants", - "ecosystem.opportunities.careers": "Careers", "ecosystem.resources.seminar": "Substrate Seminar", "ecosystem.resources.past-seminars": "Past Seminars", diff --git a/content/md/en/docs/build/genesis-configuration.md b/content/md/en/docs/build/genesis-configuration.md index f398bcb92..7375600d9 100644 --- a/content/md/en/docs/build/genesis-configuration.md +++ b/content/md/en/docs/build/genesis-configuration.md @@ -5,7 +5,7 @@ keywords: ---
- ⚠️ WARNING: This page contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
@@ -19,7 +19,7 @@ As you learned in [Chain specification](/build/chain-spec/), the chain specifica However, the chain specification doesn't create the storage items that get initialized when you start a node. Instead, the storage items are defined in the pallets included in the runtime as described in [Runtime storage](/build/runtime-storage/). -After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block. +After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block. To specify the storage items that you want to set an initial state for, Substrate provides two specialized FRAME attribute macros. The macros you can use to initialize storage items as part of the genesis configuration for a chain are: @@ -120,12 +120,17 @@ All of the `GenesisConfig` types for the pallets that included in the constructi The aggregated `RuntimeGenesisConfig` implements the [`BuildStorage`](https://paritytech.github.io/substrate/master/sp_runtime/trait.BuildStorage.html) trait to build all of the initial storage items for the runtime. For example, the node template runtime builds storage items for the following pallets that have a `RuntimeGenesisConfig` specified by default: -- [System pallet](#system-pallet) -- [Aura pallet](#aura-pallet) -- [Grandpa pallet](#grandpa-pallet) -- [Balances pallet](#balances-pallet) -- [TransactionPayment pallet](#transactionpayment-pallet) -- [Sudo pallet](#sudo-pallet) +- [Configure a simple storage value](#configure-a-simple-storage-value) + - [Configure macros in the pallet](#configure-macros-in-the-pallet) + - [Configure the chain specification](#configure-the-chain-specification) +- [Adding genesis configuration to the runtime](#adding-genesis-configuration-to-the-runtime) + - [System pallet](#system-pallet) + - [Aura pallet](#aura-pallet) + - [Grandpa pallet](#grandpa-pallet) + - [Balances pallet](#balances-pallet) + - [TransactionPayment pallet](#transactionpayment-pallet) + - [Sudo pallet](#sudo-pallet) +- [Initialize storage items within a pallet](#initialize-storage-items-within-a-pallet) ### System pallet diff --git a/content/md/en/docs/build/origins.md b/content/md/en/docs/build/origins.md index 66d4da804..428755e91 100644 --- a/content/md/en/docs/build/origins.md +++ b/content/md/en/docs/build/origins.md @@ -6,7 +6,7 @@ keywords: ---
- ⚠️ WARNING: This page contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
The runtime origin is used by dispatchable functions to check where a call has come from. diff --git a/content/md/en/docs/build/pallet-coupling.md b/content/md/en/docs/build/pallet-coupling.md index 9e900a4bc..7e0d17672 100644 --- a/content/md/en/docs/build/pallet-coupling.md +++ b/content/md/en/docs/build/pallet-coupling.md @@ -7,12 +7,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
The term **coupling** is often used to describe the degree to which two software modules depend on each other. diff --git a/content/md/en/docs/build/randomness.md b/content/md/en/docs/build/randomness.md index c5250357c..78669809d 100644 --- a/content/md/en/docs/build/randomness.md +++ b/content/md/en/docs/build/randomness.md @@ -41,7 +41,7 @@ Substrate includes two examples of how to implement the `Randomness` trait in pa You should only use this pallet in applications with low security requirements or when testing randomness-consuming applications. You shouldn't use this pallet in a production environment. -= The [BABE pallet](https://paritytech.github.io/substrate/master/pallet_babe/index.html) provides randomness by using verifiable random functions. +- The [BABE pallet](https://paritytech.github.io/substrate/master/pallet_babe/index.html) provides randomness by using verifiable random functions. This pallet provides production-grade randomness, and is used in Polkadot. If you select this pallet as the source of randomness your blockchain must use the blind assignment of blockchain extension ([BABE](/reference/glossary/#blind-assignment-of-blockchain-extension-babe)) slot-based consensus for producing blocks. diff --git a/content/md/en/docs/build/remote-procedure-calls.md b/content/md/en/docs/build/remote-procedure-calls.md index 32027e13e..896c954ae 100644 --- a/content/md/en/docs/build/remote-procedure-calls.md +++ b/content/md/en/docs/build/remote-procedure-calls.md @@ -6,6 +6,10 @@ keywords: - frontend --- +
+ Please refer to the Rust docs for the most up-to-date documentation on this topic. +
+ Remote procedure calls, or RPC methods, are a way for an external program—for example, a browser or front-end application—to communicate with a Substrate node. In general, these methods enable an RPC client to connect to an RPC server endpoint to request some type of service. For example, you might use an RPC method to read a stored value, submit a transaction, or request information about the chain a node is connected to. diff --git a/content/md/en/docs/examples/quickstart/index.html b/content/md/en/docs/examples/quickstart/index.html index 26839f0df..013743a9c 100644 --- a/content/md/en/docs/examples/quickstart/index.html +++ b/content/md/en/docs/examples/quickstart/index.html @@ -20,36 +20,36 @@ } - +

Display an account balance

Enter a development account address, then click Get Balance.

- +

Balance: Not Connected

- + - + - \ No newline at end of file + diff --git a/content/md/en/docs/install/macos.md b/content/md/en/docs/install/macos.md index 5393956c8..2f0b0c0f1 100644 --- a/content/md/en/docs/install/macos.md +++ b/content/md/en/docs/install/macos.md @@ -4,7 +4,7 @@ description: Set up a local development environment for Substrate on macOS. keywords: --- -You can install Rust and set up a Substrate development environment on Apple macOS computers with either Intel or an Apple M1 processors. +You can install Rust and set up a Substrate development environment on Apple macOS computers with either Intel or Apple Silicon (M-series) processors. ## Before you begin @@ -13,7 +13,7 @@ Before you install Rust and set up your development environment on macOS, verify - Operating system version is 10.7 Lion, or later. - Processor speed of at least 2Ghz, 3Ghz recommended. - Memory of at least 8 GB RAM, 16 GB recommended. -- Storage of at 10 GB available space. +- Storage of 10 GB available. - Broadband Internet connection. ### Support for Apple Silicon @@ -144,7 +144,7 @@ To install `openssl` and the Rust toolchain on macOS: Now that you have Rust installed and the Rust toolchains configured for Substrate development, you are ready to finish setting up your development environment by cloning the Substrate **node template** files and compiling a Substrate node. The node template provides a working environment that includes all of the most common features you need to build a blockchain without any extraneous modules or tools. -To ensure that the node template offers a relatively stable working environment for you to experiment with, the recommended best practice is to clone Substrate node template from the Substrate Developer Hub repository, rather than from the core Substrate repository. +To ensure that the node template offers a relatively stable working environment for you to experiment with, the recommended best practice is to clone the Substrate node template from the Substrate Developer Hub repository, rather than from the core Substrate repository. To compile the Substrate node template: @@ -178,7 +178,7 @@ To compile the Substrate node template: Because of the number of packages required, compiling the node can take several minutes. -After the build completes successfully, your local computer is ready for Substrate development activity. +After the build is completed successfully, your local computer is ready for Substrate development activity. ## Where to go next diff --git a/content/md/en/docs/install/troubleshoot-rust-issues.md b/content/md/en/docs/install/troubleshoot-rust-issues.md index c7eef194a..764544cf8 100644 --- a/content/md/en/docs/install/troubleshoot-rust-issues.md +++ b/content/md/en/docs/install/troubleshoot-rust-issues.md @@ -114,11 +114,11 @@ WASM_BUILD_TOOLCHAIN=nightly- cargo build --release ``` This command builds the _runtime_ using the specified nightly toolchain. -The rest of project is compiled using the _default_ toolchain, that is, the latest version of the `stable` toolchain that you have installed. +The rest of the project is compiled using the _default_ toolchain, that is, the latest version of the `stable` toolchain that you have installed. ### Downgrade the nightly toolchain -If your computer is configured to use the latest Rust `nightly` toolchain and you want to downgrade to a specific nightly version,you must first uninstall the latest `nightly` toolchain. +If your computer is configured to use the latest Rust `nightly` toolchain and you want to downgrade to a specific nightly version, you must first uninstall the latest `nightly` toolchain. For example, you can remove the latest `nightly` toolchain, then use a specific version of the `nightly` toolchain by running commands similar to the following: ```sh @@ -129,17 +129,17 @@ rustup target add wasm32-unknown-unknown --toolchain nightly- ## Ensure PATH is set correctly -If after installing Rust the commands don't seem to work, showing errors such as `command not found: rustup`, make sure it your PATH is configured correctly. +If after installing Rust the commands don't seem to work, showing errors such as `command not found: rustup`, make sure that your PATH is configured correctly. -Currently, the `rustup` installer installs by default to the bash profile (on mac). If you are using another shell, make sure to add this line to your profile (e.g. `.zshrc`): +Currently, the `rustup` installer installs by default to the bash profile (on Mac). If you are using another shell, make sure to add this line to your profile (e.g. `.zshrc`): ```bash source "$HOME/.cargo/env" ``` -## Installing cmake or protobuf for M1 macOS users +## Installing cmake or protobuf for Apple Silicon (M-series) macOS users -Currently, there are issues compiling the Substrate node when using the packages that are pre-installed on macOS computers with the M1 chip. +Currently, there are issues when compiling the Substrate node while using the packages that are pre-installed on macOS computers with the M-series chip. ```sh error: failed to run custom build command for prost-build v0.10.4 diff --git a/content/md/en/docs/learn/offchain-operations.md b/content/md/en/docs/learn/offchain-operations.md index 2161626d1..b34213aff 100644 --- a/content/md/en/docs/learn/offchain-operations.md +++ b/content/md/en/docs/learn/offchain-operations.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
There are many use cases where you might want to query data from an offchain source or process data without using on-chain resources before updating the on-chain state. diff --git a/content/md/en/docs/learn/runtime-development.md b/content/md/en/docs/learn/runtime-development.md index 67b66c68a..a86ad8b89 100644 --- a/content/md/en/docs/learn/runtime-development.md +++ b/content/md/en/docs/learn/runtime-development.md @@ -139,7 +139,6 @@ pub mod pallet { // Declare the pallet type // This is a placeholder to implement traits and methods. #[pallet::pallet] - #[pallet::generate_store(pub(super) trait Store)] pub struct Pallet(_); // Add the runtime configuration trait diff --git a/content/md/en/docs/learn/state-transitions-and-storage.md b/content/md/en/docs/learn/state-transitions-and-storage.md index 503820285..6f2619947 100644 --- a/content/md/en/docs/learn/state-transitions-and-storage.md +++ b/content/md/en/docs/learn/state-transitions-and-storage.md @@ -57,7 +57,7 @@ Substrate's [runtime storage APIs](/build/runtime-storage) expose a number of st ### Storage value keys -To calculate the key for a simple [Storage Value](/build/runtime-storage#storage-value), take the [TwoX 128 hash](https://github.com/Cyan4973/xxHash) of the name of the pallet that contains the Storage Value and append to it the TwoX 128 hash of the name of the Storage Value itself. +To calculate the key for a simple [Storage Value](/build/runtime-storage#storage-value), take the [TwoX 128 hash](https://github.com/Cyan4973/xxHash) of the name of the pallet that contains the Storage Value and prepend to it the TwoX 128 hash of the name of the Storage Value itself. For example, the [Sudo](https://paritytech.github.io/substrate/master/pallet_sudo/index.html) pallet exposes a Storage Value item named `Key`: ```rust diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md new file mode 100644 index 000000000..7d763f6e5 --- /dev/null +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -0,0 +1,39 @@ +--- +title: Polkadot SDK +description: +keywords: + - polkadot-sdk +--- + + +## Substrate to Polkadot SDK + +In [May +2023](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883), +Parity Technologies started moving the three repositories that contained +[`substrate`](https://github.com/paritytech/substrate), +[`polkadot`](https://github.com/paritytech/polkadot), and +[`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and +branding, under one new mono-repo called +[`polkadot-sdk`](https://github.com/paritytech/polkadot-sdk). Consequently, the [runtimes of the +Polkadot and Kusama relay chains, and their system chains](https://github.com/polkadot-fellows/runtimes) were moved to be maintained by the [Polkadot fellowship](polkadot-fellows.github.io/dashboard/). + +This transition gave birth to a new vision in which these tools are seen from the lens of being part of `polkadot-sdk` while still being independently useful. + +Most impacted in this transition is **Substrate**, and part of this impact is the gradual deprecation of +this website. The content on this website is no longer maintained and will be gradually moved to a +new home. Consider the [resources below](#alternative-resources) as primary sources of information. + +> You may still access the old content of this website in the navbar, but be aware of the fact that some content might not be up to date. + +Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of `polkadot-sdk`, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template). + +## Alternative Resources + +Below, you can find a number of replacement resources to learn more about Polkadot SDK: + +- [Polkadot Wiki](https://wiki.polkadot.network/docs/build-guide) +- [Polkadot Developers](https://github.com/polkadot-developers/) +- [Polkadot Blockchain Academy](https://polkadot.com/blockchain-academy) +- [Polkadot SDK Rust Docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) +- Polkadot Ecosystem Documentation by Papermoon (Work in progress, see progress [here](https://forum.polkadot.network/t/decentralized-futures-papermoon-first-updates/9265)) diff --git a/content/md/en/docs/reference/command-line-tools/node-template.md b/content/md/en/docs/reference/command-line-tools/node-template.md index b04f14119..f0da04d0d 100644 --- a/content/md/en/docs/reference/command-line-tools/node-template.md +++ b/content/md/en/docs/reference/command-line-tools/node-template.md @@ -120,7 +120,7 @@ You can use the following options with the `node-template` command. | `--wasm-execution ` | Specifies the method for executing Wasm runtime code. Valid values are `interpreted`, or `compiled`. The default is `Compiled`. | `--wasm-runtime-overrides ` | Specifies the path where local WASM runtimes are stored. These runtimes override on-chain runtimes when the version matches. | `--ws-max-connections ` | Specifies the maximum number of WS RPC server connections. -| `--rpc-port ` | Specifies the TCP port to use for the WebSockets RPC server. +| `--ws-port ` | Specifies the TCP port to use for the WebSockets RPC server. ### Subcommands diff --git a/content/md/en/docs/reference/frame-macros.md b/content/md/en/docs/reference/frame-macros.md index 6f5d3c864..07e37923f 100644 --- a/content/md/en/docs/reference/frame-macros.md +++ b/content/md/en/docs/reference/frame-macros.md @@ -4,7 +4,7 @@ description: keywords: ---
- ⚠️ WARNING: This section contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
Substrate uses customized [Rust macros](https://doc.rust-lang.org/book/ch19-06-macros.html) to generate code and aggregate the logic from the pallets you implement for a runtime. @@ -256,15 +256,6 @@ For example: pub struct Pallet(_); ``` -This macro can generate the `Store` trait to contain an associated type for each storage item if you provide the `#[pallet::generate_store($vis trait Store)]` attribute macro. - -For example: - -```rust -#[pallet::pallet] -pub struct Pallet(_); -``` - For more information about working with storage and this macro, see the [macro expansion](https://paritytech.github.io/substrate/master/frame_support/attr.pallet.html#macro-expansion-1) added to the `struct Pallet` definition. ### #[pallet::without\_storage\_info] @@ -279,7 +270,6 @@ To use it, add the `#[pallet::without_storage_info]` attribute to the pallet str ```rust #[pallet::pallet] -#[pallet::generate_store(pub(super) trait Store)] #[pallet::without_storage_info] pub struct Pallet(_); ``` diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md index 5b93d9815..d064aa973 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
The _How-to_ guides in the _Offchain workers_ category illustrate common use cases for offchain operations. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md index d49818e6e..1e396ae32 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md @@ -10,12 +10,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
Because most blockchains can't access data that's hosted on servers outside of their own network, they typically use external third-party services—**oracles**—to pull information in from or push information out to locations that are outside of the network. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md index acfb76126..abe0f791e 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md @@ -8,12 +8,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide will step you through how to pass data from an extrinsic to an offchain worker without writing to storage. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md index b5d0ebf9f..ba6290b77 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md @@ -9,12 +9,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide will teach you how to use an offchain worker to save retrieved data in local storage for future access. diff --git a/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md b/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md index 0c9ae3286..15ab0f4f8 100644 --- a/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md +++ b/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide demonstrates how to reuse a function or type from one pallet in another pallet using a technique called **loose coupling**. diff --git a/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md b/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md index c2031b9ac..2889fb20d 100644 --- a/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md +++ b/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
Tight coupling two pallets is a technique to write pallets that re-use types and methods from an existing pallet. diff --git a/content/md/en/docs/reference/xcm-reference.md b/content/md/en/docs/reference/xcm-reference.md index 74ba23bc0..839bc338f 100644 --- a/content/md/en/docs/reference/xcm-reference.md +++ b/content/md/en/docs/reference/xcm-reference.md @@ -9,12 +9,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This section provides reference information for the cross-consensus message (XCM) format. diff --git a/content/md/en/docs/test/set-up-a-test-network.md b/content/md/en/docs/test/set-up-a-test-network.md index 301a37003..7f6c2013c 100644 --- a/content/md/en/docs/test/set-up-a-test-network.md +++ b/content/md/en/docs/test/set-up-a-test-network.md @@ -53,7 +53,7 @@ To prepare a working folder with the binaries for the test network: Release branches use the naming convention `release-v`. For example, the release branch used in this tutorial is `release-v1.0.0`. You can check out a more recent release branch instead of using `release-v1.0.0`. - You can find information about recent releases and what's included in each release on the [Releases](https://github.com/paritytech/polkadot/releases) tab. + You can find information about recent releases and what's included in each release on the [Releases](https://github.com/paritytech/polkadot-sdk/releases) tab. 1. Change to the root of the `polkadot` directory by running the following command: @@ -69,10 +69,11 @@ To prepare a working folder with the binaries for the test network: Compiling the node can take 15 to 60 minuets to complete. -1. Copy the Polkadot binary into your working `bin` folder by running a command similar to the following: +1. Copy the Polkadot binary and workers into your working `bin` folder by running a command similar to the following: ```bash cp ./target/release/polkadot ../bin/polkadot-v1.0.0 + cp ./target/release/polkadot-*-worker ../bin/ ``` As this example illustrates, it's generally a good practice to append the version of `polkadot` to the binary name to keep the files in the `bin` folder organized. diff --git a/content/md/en/docs/tutorials/build-a-parachain/acquire-a-testnet-slot.md b/content/md/en/docs/tutorials/build-a-parachain/acquire-a-testnet-slot.md index 24a07707e..b4148bdc9 100644 --- a/content/md/en/docs/tutorials/build-a-parachain/acquire-a-testnet-slot.md +++ b/content/md/en/docs/tutorials/build-a-parachain/acquire-a-testnet-slot.md @@ -45,13 +45,10 @@ To prepare an account: 1. Click **Save**. -2. Join the [Rococo Element channel](https://matrix.to/#/#rococo-faucet:matrix.org) and send a message with`!drip` and the public address for your Rococo to get 100 ROC in your wallet. +2. Go to https://faucet.polkadot.io, provide your public address in the form input and submit to get 100 ROC tokens in your wallet. - For example, send a message similar to the following: - - ```text - !drip 5CVYesFxbDBU5rkZXYTAA6BnADbCoSpQkvexBQZvbtvyGTP1 - ``` + > Alternatively you can join the [Rococo Element channel](https://matrix.to/#/#rococo-faucet:matrix.org) and send a message with`!drip` and the public address for your Rococo to get 100 ROC in your wallet. + > For example, send a message similar to the following: `!drip 5CVYesFxbDBU5rkZXYTAA6BnADbCoSpQkvexBQZvbtvyGTP1` ## Reserve a parachain identifier diff --git a/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md b/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md index a7b1ced2c..68aec308e 100644 --- a/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md +++ b/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md @@ -12,12 +12,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This tutorial illustrates how to modify a pallet to include an offchain worker and configure the pallet and runtime to enable the offchain worker to submit transactions that update the on-chain state. diff --git a/content/md/en/docs/tutorials/collectibles-workshop/03-create-pallet.md b/content/md/en/docs/tutorials/collectibles-workshop/03-create-pallet.md index 9ac715ec1..7b03d9271 100644 --- a/content/md/en/docs/tutorials/collectibles-workshop/03-create-pallet.md +++ b/content/md/en/docs/tutorials/collectibles-workshop/03-create-pallet.md @@ -3,6 +3,8 @@ title: Create a new pallet tutorial: 1 --- +> ⚠️ This tutorial is out-of-date any may not work as intended. Please refer to [`Polkadot SDK Docs`](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/your_first_pallet/index.html) for up-to-date information. + In this workshop, you'll learn how to create a custom Substrate module-called a pallet-that's going to contain the code for your application-specific blockchain. Pallets are built using FRAME libraries and the Rust programming language. FRAME includes a lot of specialized macros that make it easy to compose the application logic in a reusable container. @@ -104,14 +106,14 @@ To update the manifest for the collectibles project: ```toml [dependencies] - frame-support = { default-features = false, version = "4.0.0-dev", git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-v1.0.0"} - frame-system = { default-features = false, version = "4.0.0-dev", git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-v1.0.0" } + frame-support = { default-features = false, version = "36.0.0" } + frame-system = { default-features = false, version = "36.0.0" } ``` 3. Add `codec` and `scale-info` to the dependencies. ```toml - codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive",] } + codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] } scale-info = { version = "2.1.1", default-features = false, features = ["derive"] } ``` @@ -139,7 +141,7 @@ The next step is to prepare a set of common macros to serve as scaffolding for y You now have a clean slate for creating the Substrate collectibles pallet. -2. Prepare the scaffolding for the Substrate collectibles pallet by adding the following common set of marco declarations to the `src/lib.rs` file: +2. Prepare the scaffolding for the Substrate collectibles pallet by adding the following common set of macro declarations to the `src/lib.rs` file: ```rust #![cfg_attr(not(feature = "std"), no_std)] @@ -152,7 +154,6 @@ The next step is to prepare a set of common macros to serve as scaffolding for y use frame_system::pallet_prelude::*; #[pallet::pallet] - #[pallet::generate_store(pub(super) trait Store)] pub struct Pallet(_); #[pallet::config] diff --git a/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md b/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md index 2b8305804..0153ad29a 100644 --- a/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md +++ b/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md @@ -4,6 +4,10 @@ description: Demonstrates how you can explore the Substrate REST service (sideca keywords: --- +
+ Please refer to the Sidecar docs, the README and the guides folder for the most up-to-date documentation on this topic. +
+ The Substrate [sidecar](https://github.com/paritytech/substrate-api-sidecar) service provides a REST API for interacting with Substrate blockchain nodes built using FRAME. The sidecar REST service exposes an extensive set of endpoints that enable you to interact with nodes, accounts, transactions, parachains, and many other components of a Substrate-based blockchain. @@ -94,7 +98,7 @@ To download and install `sidecar`: To use the predefined API collection for `sidecar`: -1. Open the predefined [Substrate API Sidecar](https://documenter.getpostman.com/view/24602305/2s8YsqWaj8#intro) API collection in a browser. +1. Open the predefined [Substrate API Sidecar](https://documenter.getpostman.com/view/21393319/2sA3Qs9C9M#intro) API collection in a browser. 2. Click **Run in Postman** in the top-right corner of the page. 3. Select to run the collection either using Postman for Web or in the Postman for Mac desktop client. diff --git a/content/md/en/homepage/get-started-homepage.md b/content/md/en/homepage/get-started-homepage.md index 056789623..061195f07 100644 --- a/content/md/en/homepage/get-started-homepage.md +++ b/content/md/en/homepage/get-started-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Blockchain basics bodyLinkTwoURL: /learn/blockchain-basics/ bodyLinkThreeTitle: Architecture and Rust libraries bodyLinkThreeURL: /learn/architecture/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/content/md/en/homepage/get-technical-homepage.md b/content/md/en/homepage/get-technical-homepage.md index f4af3a8a3..fe24257bf 100644 --- a/content/md/en/homepage/get-technical-homepage.md +++ b/content/md/en/homepage/get-technical-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Rust for Substrate bodyLinkTwoURL: /learn/rust-basics/ bodyLinkThreeTitle: Command-line tools bodyLinkThreeURL: /reference/command-line-tools/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/content/md/en/homepage/hands-on-homepage.md b/content/md/en/homepage/hands-on-homepage.md index 09051ed12..459a9a75a 100644 --- a/content/md/en/homepage/hands-on-homepage.md +++ b/content/md/en/homepage/hands-on-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Simulate a network bodyLinkTwoURL: /tutorials/build-a-blockchain/simulate-network/ bodyLinkThreeTitle: Add a pallet bodyLinkThreeURL: /tutorials/build-application-logic/add-a-pallet/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/example.env.development b/example.env.development index 92b603266..ee31fa503 100644 --- a/example.env.development +++ b/example.env.development @@ -1,4 +1,2 @@ # GATSBY_WEBSITE_URL=http://localhost:8100 # GATSBY_DOCS_URL=http://localhost:8200 -# GATSBY_MARKETPLACE_URL=http://localhost:8300 -# GATSBY_CAREERS_URL=https://careers.substrate.io diff --git a/example.env.production b/example.env.production index 92b603266..ee31fa503 100644 --- a/example.env.production +++ b/example.env.production @@ -1,4 +1,2 @@ # GATSBY_WEBSITE_URL=http://localhost:8100 # GATSBY_DOCS_URL=http://localhost:8200 -# GATSBY_MARKETPLACE_URL=http://localhost:8300 -# GATSBY_CAREERS_URL=https://careers.substrate.io diff --git a/src/pages/index.js b/src/pages/index.js index 0336af5aa..33154b4f1 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -2,26 +2,45 @@ import { graphql } from 'gatsby'; import { Layout, Section, SEO } from 'gatsby-plugin-substrate'; import React from 'react'; -import CardsList from '../components/layout/Documentation/CardList'; -import SearchDocumentation from '../components/ui/SearchDocumentation'; +import Card from '../components/layout/Documentation/Card'; +// import CardsList from '../components/layout/Documentation/CardList'; +// import SearchDocumentation from '../components/ui/SearchDocumentation'; export default function Home({ data }) { - const { content } = data; + // eslint-disable-next-line no-empty-pattern + const {} = data; return ( -
-

Substrate Documentation

-
-

- Substrate documentation includes conceptual, procedural, and reference information for blockchain builders - and parachain project teams. -

-
- +
+

Substrate

+

Is now part of

+

+ Polkadot SDK +

- +
); diff --git a/src/styles/scss/_home.scss b/src/styles/scss/_home.scss index 4f63d0944..7951a236c 100644 --- a/src/styles/scss/_home.scss +++ b/src/styles/scss/_home.scss @@ -135,6 +135,150 @@ transition: 0.33s; } +@import url('https://fonts.googleapis.com/css2?family=Unbounded:wght@200..900&display=swap'); + +@keyframes wobbleFade { + 0% { + transform: translate(0, 0) rotate(0deg); + opacity: 1; + text-shadow: 0px 5px 30px #24CC85; + } + 5% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.95; + text-shadow: 0px 5px 33px #24CC85; + } + 10% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.9; + text-shadow: 0px 5px 36px #24CC85; + } + 15% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.85; + text-shadow: 0px 5px 39px #24CC85; + } + 20% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.8; + text-shadow: 0px 5px 42px #24CC85; + } + 25% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.75; + text-shadow: 0px 5px 45px #24CC85; + } + 30% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.7; + text-shadow: 0px 5px 48px #24CC85; + } + 35% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.65; + text-shadow: 0px 5px 51px #24CC85; + } + 40% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.6; + text-shadow: 0px 5px 54px #24CC85; + } + 45% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.55; + text-shadow: 0px 5px 57px #24CC85; + } + 50% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.5; + text-shadow: 0px 5px 60px #24CC85; + } + 55% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.45; + text-shadow: 0px 5px 60px #24CC85; + } + 60% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.4; + text-shadow: 0px 5px 60px #24CC85; + } + 65% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.35; + text-shadow: 0px 5px 60px #24CC85; + } + 70% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 75% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 80% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 85% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 90% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 95% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 100% { + transform: translate(0, 0) rotate(0deg); + opacity: 0.3; /* End at 0.3 opacity */ + text-shadow: 0px 5px 60px #24CC85; /* End at 60px spread */ + } +} + +.substrate { + animation: wobbleFade 10s forwards; /* Use forwards to retain the final state */ + text-shadow: 0px 5px 30px #24CC85; +} + +.polkadot-sdk { + font-family: "Unbounded"; +} + +.underline-effect { + position: relative; + display: inline-block; + color: white; /* Base text color */ +} + +.underline-effect::after { + content: ''; + position: absolute; + width: 100%; + height: 5px; /* Thickness of the underline */ + top: 60px; + bottom: 0; + left: 0; + background-color: #e6007a; /* Color of the underline */ + transform: scaleX(0); + transform-origin: bottom right; + transition: transform 0.3s ease-out; +} + +.underline-effect:hover::after { + transform: scaleX(1); + transform-origin: bottom left; +} + /* Hide scrollbar on windows */ .nav-sidebar { @@ -181,7 +325,7 @@ pre { margin: 1rem 0 2rem 0; } -/* Code View */ +/* Code View */ .markdown-body a.anchor { display:none; } diff --git a/src/templates/single.js b/src/templates/single.js index e6d3fc49d..658150963 100644 --- a/src/templates/single.js +++ b/src/templates/single.js @@ -1,3 +1,4 @@ +import { useLocation } from '@reach/router'; import { graphql } from 'gatsby'; import { Layout, Link, SEO } from 'gatsby-plugin-substrate'; import React from 'react'; @@ -20,6 +21,8 @@ export default function DocsSinglePage({ data, pageContext }) { const { gitLogLatestDate } = data.markdownRemark.parent.fields != null ? data.markdownRemark.parent.fields : ''; //const pagePathNoSlash = pagePath.endsWith('/') ? pagePath.slice(0, -1) : pagePath; const relativeFilePath = data.markdownRemark.parent.relativePath; + const location = useLocation(); // Get the current location + function titleize(slug) { let words = slug.toLowerCase().replace(/-/g, ' '); words = words[0].toUpperCase() + words.substring(1); @@ -102,6 +105,17 @@ export default function DocsSinglePage({ data, pageContext }) {

{title}

+ {location.pathname !== '/polkadot-sdk' && ( +
+ ⚠️ Update Notice: +

+ + Please read Substrate to Polkadot SDK page first. + +

+
+
+ )}
diff --git a/static/assets/quickstart/index.html b/static/assets/quickstart/index.html index 26839f0df..013743a9c 100644 --- a/static/assets/quickstart/index.html +++ b/static/assets/quickstart/index.html @@ -20,36 +20,36 @@ } - +

Display an account balance

Enter a development account address, then click Get Balance.

- +

Balance: Not Connected

- + - + - \ No newline at end of file +