Skip to content

Commit b5ebaa8

Browse files
authored
Merge branch 'main' into patch-2
2 parents a3f4f92 + e85992d commit b5ebaa8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+256
-424
lines changed

README.md

-2
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ Default localhost port configuration:
8686
```env
8787
GATSBY_WEBSITE_URL=http://localhost:8100
8888
GATSBY_DOCS_URL=http://localhost:8200
89-
GATSBY_MARKETPLACE_URL=http://localhost:8300
90-
GATSBY_CAREERS_URL=https://careers.substrate.io
9189
```
9290

9391
**Start development server**

config/menus.js

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const { MARKETPLACE_URL, WEBSITE_URL, CAREERS_URL } = require('./webConsts.js');
1+
const { WEBSITE_URL } = require('./webConsts.js');
22

33
/* the main menu, ids of items must match
44
the submenu's key of this js object */
@@ -58,14 +58,6 @@ const developers = [
5858
url: 'https://paritytech.github.io/substrate/master/sc_service/',
5959
id: 'developers.rustdocs',
6060
},
61-
{
62-
url: MARKETPLACE_URL,
63-
id: 'developers.marketplace',
64-
},
65-
{
66-
url: WEBSITE_URL + '/developers/playground/',
67-
id: 'developers.playground',
68-
},
6961
{
7062
url: WEBSITE_URL + '/developers/smart-contracts/',
7163
id: 'developers.smart-contracts',
@@ -132,10 +124,6 @@ const opportunities = [
132124
url: WEBSITE_URL + '/ecosystem/opportunities/grants',
133125
id: 'ecosystem.opportunities.grants',
134126
},
135-
{
136-
url: CAREERS_URL,
137-
id: 'ecosystem.opportunities.careers',
138-
},
139127
];
140128

141129
const resources = [

config/siteMetadata.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const menus = require('./menus.js');
2-
const { WEBSITE_URL, DOCS_URL, MARKETPLACE_URL, CAREERS_URL } = require('./webConsts.js');
2+
const { WEBSITE_URL, DOCS_URL } = require('./webConsts.js');
33

44
module.exports = {
55
menus,
@@ -10,8 +10,6 @@ module.exports = {
1010
siteUrl: DOCS_URL,
1111
websiteUrl: WEBSITE_URL,
1212
docsUrl: DOCS_URL,
13-
marketplaceUrl: MARKETPLACE_URL,
14-
careersUrl: CAREERS_URL,
1513
author: 'Parity WebDev/W3F WebOps',
1614
pressEmail: '[email protected]',
1715

config/webConsts.js

-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
const WEBSITE_URL = process.env.GATSBY_WEBSITE_URL;
22
const DOCS_URL = process.env.GATSBY_DOCS_URL;
3-
const MARKETPLACE_URL = process.env.GATSBY_MARKETPLACE_URL;
4-
const CAREERS_URL = process.env.GATSBY_CAREERS_URL;
53

64
module.exports = {
75
WEBSITE_URL,
86
DOCS_URL,
9-
MARKETPLACE_URL,
10-
CAREERS_URL,
117
};

content/locales/en/menus.json

-3
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
"developers.home": "Home",
1515
"developers.docs": "Docs",
1616
"developers.rustdocs": "Rust Docs",
17-
"developers.marketplace": "Marketplace",
18-
"developers.playground": "Playground",
1917
"developers.smart-contracts": "Smart Contracts",
2018
"developers.substrate-connect": "Substrate Connect",
2119
"developers.rococo-network": "Rococo Network",
@@ -32,7 +30,6 @@
3230

3331
"ecosystem.opportunities.hackathons": "Hackathons",
3432
"ecosystem.opportunities.grants": "Grants",
35-
"ecosystem.opportunities.careers": "Careers",
3633

3734
"ecosystem.resources.seminar": "Substrate Seminar",
3835
"ecosystem.resources.past-seminars": "Past Seminars",

content/md/en/docs/build/build-process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,6 @@ This option is primarily used for faster compile time when you don't need to upd
138138

139139
## Where to go next
140140

141-
- [Wasm-builder README](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/utils/wasm-builder/README.md)
141+
- [Wasm-builder source](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/utils/wasm-builder/src/lib.rs)
142142
- [Rust compilation options](https://doc.rust-lang.org/cargo/commands/cargo-build.html#compilation-options)
143143
- [Discussion: Removing the native runtime](https://github.com/paritytech/substrate/issues/10579)

content/md/en/docs/build/genesis-configuration.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description:
44
keywords:
55
---
66

7+
<div class="warning">
8+
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.genesis_build.html">Rust docs</a> for the most up-to-date documentation on this topic.
9+
</div>
10+
11+
712
The first block produced by any blockchain is referred to as the genesis block.
813
The hash associated with this block is the top-level parent of all blocks produced after that first block.
914

content/md/en/docs/build/origins.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ keywords:
55
- origins
66
---
77

8+
<div class="warning">
9+
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_origin/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
10+
</div>
11+
812
The runtime origin is used by dispatchable functions to check where a call has come from.
913

1014
## Raw origins

content/md/en/docs/build/pallet-coupling.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ keywords:
66
- pallet design
77
---
88

9+
<div class="warning">
10+
<p>
11+
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
12+
</p>
13+
<p>
14+
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
15+
</p>
16+
</div>
17+
918
The term **coupling** is often used to describe the degree to which two software modules depend on each other.
1019
For example, in object-oriented programming tight coupling and loose coupling are used to describe the relationship between objects classes:
1120

content/md/en/docs/build/remote-procedure-calls.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ keywords:
66
- frontend
77
---
88

9+
<div class="warning">
10+
<strong>⚠️ WARNING:</strong> This page may contain outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/custom_runtime_api_rpc/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
11+
</div>
12+
913
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.
1014
In general, these methods enable an RPC client to connect to an RPC server endpoint to request some type of service.
1115
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.

content/md/en/docs/build/tx-weights-fees.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@ use frame_support:: {
237237
Pays::Yes,
238238
},
239239
weights::Weight,
240+
};
240241

241242
#[pallet::weight(FunctionOf(
242243
|args: (&Vec<User>,)| args.0.len().saturating_mul(10_000),
243244
)
244245
]
245-
246246
fn handle_users(origin, calls: Vec<User>) {
247247
// Do something per user
248248
}

content/md/en/docs/deploy/keys-and-network-operations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ Session keys are private online keys that are used by validators to sign consens
3636
Session keys must be available online to enable the validator to perform certain network operations.
3737

3838
These keys aren't used to control funds and they should only be used for their intended purpose.
39-
They can be changed regularly
39+
They can be changed regularly.
4040
To create session keys, a validator node operator must use a controller account too generate a certificate signed with the session's public key.
4141
The certificate attests that the key acts on behalf of the validator's staking account and nominators.
4242
After creating the session key, the validator node operator informs the chain that this key represents the controller key by
4343
publishing the session certificate in a transaction on the chain.
44-
In most cases, node operators use the [Session](https://paritytech.github.io/substrate/master/pallet_session/index.html)) pallet to manage their session keys.
44+
In most cases, node operators use the [Session](https://paritytech.github.io/substrate/master/pallet_session/index.html) pallet to manage their session keys.
4545

4646
The [`SessionKeys`](https://paritytech.github.io/substrate/master/sp_session/index.html)
4747
trait is a generic, indexable type and you can declare any number of session keys in the runtime.

content/md/en/docs/learn/accounts-addresses-keys.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The secret seed phrase is important because it can be used to recover access to
2020

2121
For most networks, the **public key** associated with an account is how that account is identified on the network and some form of it is used as the destination address for transactions.
2222
However, Substrate-based chains use the underlying public key to derive one or more **public addresses**.
23-
Instead of using the public key directly, Substrate allows you generate multiple addresses and address formats for an account.
23+
Instead of using the public key directly, Substrate allows you to generate multiple addresses and address formats for an account.
2424

2525
## Address encoding and chain-specific addresses
2626

@@ -74,7 +74,7 @@ For more information about working with generic types, see [Rust for Substrate](
7474

7575
## Specialized accounts
7676

77-
As a flexible and module framework for blockchain development, Substrate itself doesn't require you define or use any specific type of accounts.
77+
As a flexible and module framework for blockchain development, Substrate itself doesn't require you to define or use any specific type of accounts.
7878
However, different chains can implement different rules for how accounts and the keys that control them are used.
7979
For example, you might implement specialized accounts if your application requires:
8080

content/md/en/docs/learn/blockchain-basics.md

-2
Original file line numberDiff line numberDiff line change
@@ -108,5 +108,3 @@ You can explore the following resources to learn more.
108108
- [Build a local blockchain](/tutorials/build-a-blockchain/build-local-blockchain/)
109109
- [Simulate a network](/tutorials/build-a-blockchain/simulate-network/)
110110
- [Add trusted nodes](/tutorials/build-a-blockchain/add-trusted-nodes/)
111-
112-
If you prefer to explore code directly, you can start building in the [Substrate Playground](/playground/) or consult the API reference to get details about the Rust crates you use.

content/md/en/docs/learn/light-clients-in-substrate-connect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A few of the key benefits include:
4343

4444
You can use Substrate Connect to connect to any Substrate-based blockchain.
4545
However, you must specify the correct name of the chain that you want to connect to.
46-
There are a few well-known chain names that are defined for the [`WellKnownChain`](https://paritytech.github.io/substrate-connect/api/enums/connect_src.WellKnownChain.html) enumeration type.
46+
There are a few well-known chain names that are defined for the [`WellKnownChain`](https://paritytech.github.io/substrate-connect/api/enums/_substrate_connect.WellKnownChain.html) enumeration type.
4747

4848
You can connect to the following public blockchain networks using the name listed:
4949

content/md/en/docs/learn/offchain-operations.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ description: Highlights how you can integrate data from offchain sources into th
44
keywords:
55
---
66

7+
<div class="warning">
8+
<p>
9+
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
10+
</p>
11+
<p>
12+
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
13+
</p>
14+
</div>
15+
716
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.
817
The conventional way of incorporating offchain data involves connecting to [oracles](/reference/glossary#oracle) to supply the data from some traditional source.
918
Although using oracles is one approach to working with offchain data sources, there are limitations to the security, scalability, and infrastructure efficiency that oracles can provide.

content/md/en/docs/learn/runtime-development.md

-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,6 @@ pub mod pallet {
139139
// Declare the pallet type
140140
// This is a placeholder to implement traits and methods.
141141
#[pallet::pallet]
142-
#[pallet::generate_store(pub(super) trait Store)]
143142
pub struct Pallet<T>(_);
144143

145144
// Add the runtime configuration trait

content/md/en/docs/learn/rust-basics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Being the language of choice for Substrate, Rust is a highly performant programm
1717

1818
## Rust in Substrate
1919

20-
In the [Architecture]() section, you will learn that Substrate is made of two distinct architectural components: the outer node and the runtime.
20+
In the [Architecture](/learn/architecture/) section, you will learn that Substrate is made of two distinct architectural components: the outer node and the runtime.
2121
While more complex features in Rust such as multithreading and asynchronous Rust are used in the outer node code, they aren't directly exposed to runtime engineers, making it easier for runtime engineers to focus on the business logic of their node.
2222

2323
Generally, depending on their focus, developers should expect to know:
@@ -40,7 +40,7 @@ These macros allow you to focus on writing idiomatic Rust and application-specif
4040

4141
Rust macros are a powerful tool to help ensure certain requirements are met (without re-writing code) such as the logic to be formatted in a specific way, specific checks are made, or some logic consists of specific data structures.
4242
This is especially useful to help developers write code that can integrate with the complexity of a Substrate runtime.
43-
For example, the `#[frame_system::pallet]` macro is required in all FRAME pallets to help you correctly implement certain required attributes-such as storage items or externally callable functions-and make it compatible with the build process in `construct_runtime`.
43+
For example, the `#[frame_support::pallet]` macro is required in all FRAME pallets to help you correctly implement certain required attributes-such as storage items or externally callable functions-and make it compatible with the build process in `construct_runtime`.
4444

4545
Developing Substrate runtimes involves heavy use of Rust's attribute macros, which come in two flavors: derive attributes and custom attributes.
4646
When you're getting started with Substrate, it isn't so important to know exactly how they work, but rather to know that they exist that they empower you to write correct runtime code.

content/md/en/docs/learn/transaction-lifecycle.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ If a transaction is invalid—for example, because it is too large or doesn't co
8181
A transaction might be rejected for any of the following reasons:
8282

8383
- The transaction has already been included in a block so it is dropped from the verifying queue.
84-
- The transaction's signature is invalid, so it is immediately be rejected.
85-
- The transaction is too large to fit in the current block, so it is be put back in a queue for a new verification round.
84+
- The transaction's signature is invalid, so it is immediately rejected.
85+
- The transaction is too large to fit in the current block, so it is put back in a queue for a new verification round.
8686

8787
## Transactions ordered by priority
8888

@@ -136,7 +136,7 @@ Before committing any state changes to storage, the runtime logic should perform
136136

137137
Note that [events](/build/events-and-errors/) are also written to storage.
138138
Therefore, the runtime logic should not emit an event before performing the complementary actions.
139-
If a transaction fails after an event is emitted, the event is not be reverted.
139+
If a transaction fails after an event is emitted, the event is not reverted.
140140

141141
### Finalizing a block
142142

content/md/en/docs/learn/what-can-you-build.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Individual pallets are typically easy to develop by using FRAME and easy for Sub
9292

9393
### Writing correct code
9494

95-
It's worth noting that pallets don't inherently provide any of type of protection or safeguards that smart contracts provide.
95+
It's worth noting that pallets don't inherently provide any type of protection or safeguards that smart contracts provide.
9696
With pallets, you control the logic available for runtime developers to implement.
9797
You provide the methods, storage items, events, and errors that your module requires.
9898
Pallets don't inherently introduce a fee or metering system.
@@ -101,7 +101,7 @@ This lack of built-in safeguards implies that you have a great deal of responsib
101101

102102
### Pallets outside of runtime development
103103

104-
Often, writing a pallet is the gateway to runtime development, giving you the opportunity to experiment with existing pallets and coding patterns without building a compete blockchain application.
104+
Often, writing a pallet is the gateway to runtime development, giving you the opportunity to experiment with existing pallets and coding patterns without building a complete blockchain application.
105105
Individual pallets also provide an alternative way you can contribute to a project without writing your own application.
106106

107107
Although writing and testing pallets is typically a stepping stone to building larger scale application, there are many examples of the value individual pallets can have to the ecosystem as a whole.
@@ -170,7 +170,7 @@ The only requirement is that your parachain or parathread must be compatible wit
170170

171171
### Planning parachain resource requirements
172172

173-
As a parachain, your project can offer functionality to a broader community in a more secure way that a private chain or a solo chain.
173+
As a parachain, your project can offer functionality to a broader community in a more secure way than a private chain or a solo chain.
174174
However, if you want to build a production-ready parachain, you should keep the following additional requirements in mind:
175175

176176
- You'll need a development team with sufficient skills and experience, whether that means programming in Rust or a background in UX design.
@@ -196,7 +196,7 @@ For example, building a parachain might be the best option for the following use
196196
- Digital wallets
197197
- Internet of things (IOT) applications
198198
- Gaming applications
199-
- Web 3.0 infrastructureM
199+
- Web 3.0 infrastructure
200200

201201
### Explore building a parachain
202202

content/md/en/docs/learn/xcm-communication.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ There are several other registers in the XCVM to handle specific tasks.
8383
For example, there's a surplus weight register to store any overestimation of fees and a refunded weight register to store the portion of surplus weight that has been refunded.
8484
In general, you can't modify the values stored in the registers directly.
8585
Instead, values are set when the XCM executor program starts and are manipulated by specific instructions, under certain circumstances, or according to certain rules.
86-
FOr more information about what's contained in each register, see [XCM reference](/reference/xcm-reference/).
86+
For more information about what's contained in each register, see [XCM reference](/reference/xcm-reference/).
8787

8888
### Configuration
8989

content/md/en/docs/maintain/runtime-upgrades.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If a runtime upgrade requires changes to the existing state, it is likely to req
1919

2020
In [Build process](/main-docs/build/build-process/), you learned that compiling a node generated both a platform-native binary and a WebAssembly binary and that selecting which binary to use at different points in the block production process can be controlled by execution strategy command-line options.
2121
The component that selects the runtime execution environment to communicate with is called the **executor**.
22-
Although you can override the default execution strategies for custom scenarios, in most cases, or the executor select the appropriate binary to use by evaluating the following information for both the native and WebAssembly runtime binaries:
22+
Although you can override the default execution strategies for custom scenarios, in most cases the executor select the appropriate binary to use by evaluating the following information for both the native and WebAssembly runtime binaries:
2323

2424
- `spec_name`
2525
- `spec_version`

0 commit comments

Comments
 (0)