Update READMEs, fix links (#7176)

* Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Revert stuff that shouldn't have been committed * Revert stuff that shouldn't have been committed * Fix parent relative link generation * Manually remove this incorrect link for now.
2026-04-26 01:47:55 +00:00 · 2020-09-22 15:38:23 +02:00
parent f70ef87a0c
commit 22632efc5f
174 changed files with 319 additions and 121 deletions
@@ -7,6 +7,7 @@ license = "Unlicense"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet template for defining custom runtime logic."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ build = "build.rs"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -6,6 +6,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [[bin]]
 path = "src/main.rs"
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate client interfaces."
 documentation = "https://docs.rs/sc-client-api"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate authority discovery."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Basic implementation of block-authoring logic."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate block builder"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate chain configurations."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -4,7 +4,7 @@ This crate contains structs and utilities to declare
 a runtime-specific configuration file (a.k.a chain spec).

 Basic chain spec type containing all required parameters is
-[`ChainSpec`](./struct.ChainSpec.html). It can be extended with
+[`ChainSpec`](https://docs.rs/sc-chain-spec/latest/sc_chain_spec/struct.ChainSpec.html). It can be extended with
 additional options that contain configuration specific to your chain.
 Usually the extension is going to be an amalgamate of types exposed
 by Substrate core modules. To allow the core modules to retrieve
@@ -25,7 +25,7 @@ pub type MyChainSpec<G> = GenericChainSpec<G, MyExtension>;

 Some parameters may require different values depending on the
 current blockchain height (a.k.a. forks). You can use `ChainSpecGroup`
-macro and provided [`Forks`](./struct.Forks.html) structure to put
+macro and provided [`Forks`](https://docs.rs/sc-chain-spec/latest/sc_chain_spec/struct.Forks.html) structure to put
 such parameters to your chain spec.
 This will allow to override a single parameter starting at specific
 block number.
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-consensus-babe"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Collection of common consensus specific imlementations for Substrate (client)"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ build = "build.rs"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Client backend that uses RocksDB database as storage."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "A crate that provides means of executing/dispatching calls into the runtime."
 documentation = "https://docs.rs/sc-executor"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "A set of common definitions that are needed for defining execution engines."
 documentation = "https://docs.rs/sc-executor-common/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "This crate provides an implementation of `WasmRuntime` that is baked by wasmi."
 documentation = "https://docs.rs/sc-executor-wasmi"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Defines a `WasmRuntime` that uses the Wasmtime JIT to execute."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Integration of the GRANDPA finality gadget into substrate."
 documentation = "https://docs.rs/sc-finality-grandpa"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -6,6 +6,7 @@ description = "RPC extensions for the GRANDPA finality gadget"
 repository = "https://github.com/paritytech/substrate/"
 edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
+readme = "README.md"

 [dependencies]
 sc-finality-grandpa = { version = "0.8.0-rc6", path = "../" }
@@ -7,6 +7,7 @@ edition = "2018"
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Keystore (and session key management) for ed25519 based chains like Polkadot."
 documentation = "https://docs.rs/sc-keystore"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ edition = "2018"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-light"
+readme = "README.md"

 [dependencies]
 parking_lot = "0.10.0"
@@ -8,6 +8,7 @@ edition = "2018"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-network-gossip"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ edition = "2018"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-network"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2018"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
 edition = "2018"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-peerset"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Basic metrics for block production."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate RPC interfaces."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate RPC servers."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate Client RPC"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate service. Starts a thread that spins up the network, client, and extrinsic pool. Manages communication between them."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "State database maintenance. Handles canonicalization and pruning in the database."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 documentation = "https://docs.rs/sc-telemetry"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Instrumentation implementation for substrate."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Substrate transaction pool implementation."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Generic Transaction Pool"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME asset management pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -11,9 +11,9 @@ with a fixed supply, including:
 * Asset Transfer
 * Asset Destruction

-To use it in your runtime, you need to implement the assets [`Trait`](./trait.Trait.html).
+To use it in your runtime, you need to implement the assets [`Trait`](https://docs.rs/pallet-assets/latest/pallet_assets/trait.Trait.html).

-The supported dispatchable functions are documented in the [`Call`](./enum.Call.html) enum.
+The supported dispatchable functions are documented in the [`Call`](https://docs.rs/pallet-assets/latest/pallet_assets/enum.Call.html) enum.

 ### Terminology

@@ -43,7 +43,7 @@ the function caller's account (`origin`) to a `target` account.
 * `destroy` - Destroys the entire holding of a fungible asset `id` associated with the account
 that called the function.

-Please refer to the [`Call`](./enum.Call.html) enum and its associated variants for documentation on each function.
+Please refer to the [`Call`](https://docs.rs/pallet-assets/latest/pallet_assets/enum.Call.html) enum and its associated variants for documentation on each function.

 ### Public Functions
 <!-- Original author of descriptions: @gavofyork -->
@@ -51,7 +51,7 @@ Please refer to the [`Call`](./enum.Call.html) enum and its associated variants
 * `balance` - Get the asset `id` balance of `who`.
 * `total_supply` - Get the total supply of an asset `id`.

-Please refer to the [`Module`](./struct.Module.html) struct for details on publicly available functions.
+Please refer to the [`Module`](https://docs.rs/pallet-assets/latest/pallet_assets/struct.Module.html) struct for details on publicly available functions.

 ## Usage

@@ -110,7 +110,7 @@ them are violated, the behavior of this module is undefined.

 ## Related Modules

-* [`System`](../frame_system/index.html)
-* [`Support`](../frame_support/index.html)
+* [`System`](https://docs.rs/frame-system/latest/frame_system/)
+* [`Support`](https://docs.rs/frame-support/latest/frame_support/)

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME atomic swap pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -2,9 +2,9 @@

 A module for atomically sending funds.

- [`atomic_swap::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`atomic_swap::Trait`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/struct.Module.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME AURA consensus pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,7 +1,7 @@
 # Aura Module

- [`aura::Trait`](./trait.Trait.html)
- [`Module`](./struct.Module.html)
+- [`aura::Trait`](https://docs.rs/pallet-aura/latest/pallet_aura/trait.Trait.html)
+- [`Module`](https://docs.rs/pallet-aura/latest/pallet_aura/struct.Module.html)

 ## Overview

@@ -15,14 +15,14 @@ The Aura module extends Aura consensus by managing offline reporting.

 ## Related Modules

- [Timestamp](../pallet_timestamp/index.html): The Timestamp module is used in Aura to track
+- [Timestamp](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/): The Timestamp module is used in Aura to track
 consensus rounds (via `slots`).

 ## References

 If you're interested in hacking on this module, it is useful to understand the interaction with
 `substrate/primitives/inherents/src/lib.rs` and, specifically, the required implementation of
-[`ProvideInherent`](../sp_inherents/trait.ProvideInherent.html) and
-[`ProvideInherentData`](../sp_inherents/trait.ProvideInherentData.html) to create and check inherents.
+[`ProvideInherent`](https://docs.rs/sp-inherents/latest/sp_inherents/trait.ProvideInherent.html) and
+[`ProvideInherentData`](https://docs.rs/sp-inherents/latest/sp_inherents/trait.ProvideInherentData.html) to create and check inherents.

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for authority discovery"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
 license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Consensus extension module for BABE consensus. Collects on-chain randomness from VRF outputs and manages epoch transitions."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet to manage balances"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -2,9 +2,9 @@

 The Balances module provides functionality for handling accounts and balances.

- [`balances::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`balances::Trait`](https://docs.rs/pallet-balances/latest/pallet_balances/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-balances/latest/pallet_balances/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-balances/latest/pallet_balances/struct.Module.html)

 ## Overview

@@ -53,16 +53,16 @@ locks always operate over the same funds, so they "overlay" rather than "stack".
 The Balances module provides implementations for the following traits. If these traits provide the functionality
 that you need, then you can avoid coupling with the Balances module.

- [`Currency`](../frame_support/traits/trait.Currency.html): Functions for dealing with a
+- [`Currency`](https://docs.rs/frame-support/latest/frame_support/traits/trait.Currency.html): Functions for dealing with a
 fungible assets system.
- [`ReservableCurrency`](../frame_support/traits/trait.ReservableCurrency.html):
+- [`ReservableCurrency`](https://docs.rs/frame-support/latest/frame_support/traits/trait.ReservableCurrency.html):
 Functions for dealing with assets that can be reserved from an account.
- [`LockableCurrency`](../frame_support/traits/trait.LockableCurrency.html): Functions for
+- [`LockableCurrency`](https://docs.rs/frame-support/latest/frame_support/traits/trait.LockableCurrency.html): Functions for
 dealing with accounts that allow liquidity restrictions.
- [`Imbalance`](../frame_support/traits/trait.Imbalance.html): Functions for handling
+- [`Imbalance`](https://docs.rs/frame-support/latest/frame_support/traits/trait.Imbalance.html): Functions for handling
 imbalances between total issuance in the system and account balances. Must be used when a function
 creates new funds (e.g. a reward) or destroys some funds (e.g. a system fee).
- [`IsDeadAccount`](../frame_system/trait.IsDeadAccount.html): Determiner to say whether a
+- [`IsDeadAccount`](https://docs.rs/frame-system/latest/frame_system/trait.IsDeadAccount.html): Determiner to say whether a
 given account is unused.

 ## Interface
@@ -113,7 +113,7 @@ fn update_ledger<T: Trait>(

 ## Genesis config

-The Balances module depends on the [`GenesisConfig`](./struct.GenesisConfig.html).
+The Balances module depends on the [`GenesisConfig`](https://docs.rs/pallet-balances/latest/pallet_balances/struct.GenesisConfig.html).

 ## Assumptions

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Macro for benchmarking a FRAME runtime."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Collective system: Members of a set of account IDs can make their collective feelings known through dispatched calls from one of two specialized origins."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -3,11 +3,14 @@ through dispatched calls from one of two specialized origins.

 The membership can be provided in one of two ways: either directly, using the Root-dispatchable
 function `set_members`, or indirectly, through implementing the `ChangeMembers`.
-The pallet assumes that the amount of members stays at or below `MAX_MEMBERS` for its weight
+The pallet assumes that the amount of members stays at or below `MaxMembers` for its weight
 calculations, but enforces this neither in `set_members` nor in `change_members_sorted`.

-A "prime" member may be set allowing their vote to act as the default vote in case of any
-abstentions after the voting period.
+A "prime" member may be set to help determine the default vote behavior based on chain
+config. If `PreimDefaultVote` is used, the prime vote acts as the default vote in case of any
+abstentions after the voting period. If `MoreThanMajorityThenPrimeDefaultVote` is used, then
+abstentations will first follow the majority of the collective voting, and then the prime
+member.

 Voting happens through motions comprising a proposal (i.e. a curried dispatchable) plus a
 number of approvals required for it to pass and be called. Motions are open for members to
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for WASM contracts"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -2,8 +2,8 @@

 The Contract module provides functionality for the runtime to deploy and execute WebAssembly smart-contracts.

- [`contract::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`contract::Trait`](https://docs.rs/pallet-contracts/latest/pallet_contracts/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-contracts/latest/pallet_contracts/enum.Call.html)

 ## Overview

@@ -59,6 +59,6 @@ WebAssembly based smart contracts in the Rust programming language. This is a wo

 ## Related Modules

-* [Balances](../pallet_balances/index.html)
+* [Balances](https://docs.rs/pallet-balances/latest/pallet_balances/)

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "A crate that hosts a common definitions that are relevant for the pallet-contracts."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Node-specific RPC methods for interaction with contracts."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Runtime API definition required by Contracts RPC extensions."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for democracy"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,7 +1,7 @@
 # Democracy Pallet

- [`democracy::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`democracy::Trait`](https://docs.rs/pallet-democracy/latest/pallet_democracy/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-democracy/latest/pallet_democracy/enum.Call.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet based on seq-Phragmén election method."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -60,8 +60,8 @@ being re-elected at the end of each round.

 ### Module Information

- [`election_sp_phragmen::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`election_sp_phragmen::Trait`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/struct.Module.html)

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for elections"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME EVM contracts pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Unlicense"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME example pallet for offchain worker"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -6,9 +6,9 @@ concepts, APIs and structures common to most offchain workers.
 Run `cargo doc --package pallet-example-offchain-worker --open` to view this module's
 documentation.

- [`pallet_example_offchain_worker::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`pallet_example_offchain_worker::Trait`](https://docs.rs/pallet-example-offchain-worker/latest/pallet_example_offchain_worker/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-example-offchain-worker/latest/pallet_example_offchain_worker/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-example-offchain-worker/latest/pallet_example_offchain_worker/struct.Module.html)


 ## Overview
@@ -7,6 +7,7 @@ license = "Unlicense"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME example pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -45,9 +45,9 @@ Copy and paste this template from frame/example/src/lib.rs into file
 // Include the following links that shows what trait needs to be implemented to use the pallet
 // and the supported dispatchables that are documented in the Call enum.

- \[`<INSERT_CUSTOM_PALLET_NAME>::Trait`](./trait.Trait.html)
- \[`Call`](./enum.Call.html)
- \[`Module`](./struct.Module.html)
+- \[`<INSERT_CUSTOM_PALLET_NAME>::Trait`](https://docs.rs/pallet-example/latest/pallet_example/trait.Trait.html)
+- \[`Call`](https://docs.rs/pallet-example/latest/pallet_example/enum.Call.html)
+- \[`Module`](https://docs.rs/pallet-example/latest/pallet_example/struct.Module.html)

 \## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME executives engine"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,7 +7,7 @@ extrinsic calls to the respective modules in the runtime.

 The executive module is not a typical pallet providing functionality around a specific feature.
 It is a cross-cutting framework component for the FRAME. It works in conjunction with the
-[FRAME System module](../frame_system/index.html) to perform these cross-cutting functions.
+[FRAME System module](https://docs.rs/frame-system/latest/frame_system/) to perform these cross-cutting functions.

 The Executive module provides functions to:

@@ -27,7 +27,7 @@ The Executive module provides the following implementations:

 ## Usage

-The default Substrate node template declares the [`Executive`](./struct.Executive.html) type in its library.
+The default Substrate node template declares the [`Executive`](https://docs.rs/frame-executive/latest/frame_executive/struct.Executive.html) type in its library.

 ### Example

@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME Pallet that tracks the last finalized block, as perceived by block authors."
 documentation = "https://docs.rs/pallet-finality-tracker"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for GRANDPA finality gadget"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME identity management pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,7 +1,7 @@
 # Identity Module

- [`identity::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`identity::Trait`](https://docs.rs/pallet-identity/latest/pallet_identity/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-identity/latest/pallet_identity/enum.Call.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME's I'm online pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -10,12 +10,12 @@ in the current era or session.

 The heartbeat is a signed transaction, which was signed using the session key
 and includes the recent best block number of the local validators chain as well
-as the [NetworkState](../../client/offchain/struct.NetworkState.html).
+as the `NetworkState`.
 It is submitted as an Unsigned Transaction via off-chain workers.

- [`im_online::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`im_online::Trait`](https://docs.rs/pallet-im-online/latest/pallet_im_online/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-im-online/latest/pallet_im_online/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-im-online/latest/pallet_im_online/struct.Module.html)

 ## Interface

@@ -46,6 +46,6 @@ decl_module! {

 ## Dependencies

-This module depends on the [Session module](../pallet_session/index.html).
+This module depends on the [Session module](https://docs.rs/pallet-session/latest/pallet_session/).

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME indices management pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME membership management pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "Decodable variant of the RuntimeMetadata."
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME multi-signature dispatch pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,8 +1,8 @@
 # Multisig Module
 A module for doing multisig dispatch.

- [`multisig::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`multisig::Trait`](https://docs.rs/pallet-multisig/latest/pallet_multisig/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-multisig/latest/pallet_multisig/enum.Call.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for nick management"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,12 +1,14 @@
 # Nicks Module

- [`nicks::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`nicks::Trait`](https://docs.rs/pallet-nicks/latest/pallet_nicks/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-nicks/latest/pallet_nicks/enum.Call.html)

 ## Overview

-Nicks is a trivial module for keeping track of account names on-chain. It makes no effort to
-create a name hierarchy, be a DNS replacement or provide reverse lookups.
+Nicks is an example module for keeping track of account names on-chain. It makes no effort to
+create a name hierarchy, be a DNS replacement or provide reverse lookups. Furthermore, the
+weights attached to this module's dispatchable functions are for demonstration purposes only and
+have not been designed to be economically secure. Do not use this pallet as-is in production.

 ## Interface

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME offences pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME offences pallet benchmarking"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME proxying pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -2,8 +2,12 @@
 A module allowing accounts to give permission to other accounts to dispatch types of calls from
 their signed origin.

- [`proxy::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+The accounts to which permission is delegated may be requied to announce the action that they
+wish to execute some duration prior to execution happens. In this case, the target account may
+reject the announcement and in doing so, veto the execution.
+
+- [`proxy::Trait`](https://docs.rs/pallet-proxy/latest/pallet_proxy/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-proxy/latest/pallet_proxy/enum.Call.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME randomness collective flip pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,6 +1,6 @@
 # Randomness Module

-The Randomness Collective Flip module provides a [`random`](./struct.Module.html#method.random)
+The Randomness Collective Flip module provides a [`random`](https://docs.rs/pallet-randomness-collective-flip/latest/pallet_randomness_collective_flip/struct.Module.html#method.random)
 function that generates low-influence random values based on the block hashes from the previous
 `81` blocks. Low-influence randomness can be useful when defending against relatively weak
 adversaries. Using this pallet as a randomness source is advisable primarily in low-security
@@ -8,7 +8,7 @@ situations like testing.

 ## Public Functions

-See the [`Module`](./struct.Module.html) struct for details of publicly available functions.
+See the [`Module`](https://docs.rs/pallet-randomness-collective-flip/latest/pallet_randomness_collective_flip/struct.Module.html) struct for details of publicly available functions.

 ## Usage

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME account recovery pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -1,7 +1,7 @@
 # Recovery Pallet

- [`recovery::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
+- [`recovery::Trait`](https://docs.rs/pallet-recovery/latest/pallet_recovery/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-recovery/latest/pallet_recovery/enum.Call.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Unlicense"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME example pallet"
+readme = "README.md"

 [dependencies]
 serde = { version = "1.0.101", optional = true }
@@ -1,9 +1,9 @@
 # Scheduler
 A module for scheduling dispatches.

- [`scheduler::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`scheduler::Trait`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/struct.Module.html)

 ## Overview

@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME pallet for scored pools"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
@@ -20,9 +20,9 @@ time. If an entity is currently a member, this results in removal
 from the `Pool` and `Members`; the entity is immediately replaced
 by the next highest scoring candidate in the pool, if available.

- [`scored_pool::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)
+- [`scored_pool::Trait`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/trait.Trait.html)
+- [`Call`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/enum.Call.html)
+- [`Module`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/struct.Module.html)

 ## Interface

@@ -61,6 +61,6 @@ decl_module! {

 ## Dependencies

-This module depends on the [System module](../frame_system/index.html).
+This module depends on the [System module](https://docs.rs/frame-system/latest/frame_system/).

 License: Apache-2.0
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 homepage = "https://substrate.dev"
 repository = "https://github.com/paritytech/substrate/"
 description = "FRAME sessions pallet"
+readme = "README.md"

 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]
--- a/Show More
+++ b/Show More