Point documentation links to monorepo (#1741)

This commit is contained in:
Sebastian Kunert
2023-09-29 22:33:26 +02:00
committed by GitHub
parent f820dc0a1f
commit 9485b0b492
44 changed files with 83 additions and 82 deletions
+4 -4
View File
@@ -7,12 +7,12 @@ in the [Substrate Developer Hub Parachain
Template](https://github.com/substrate-developer-hub/substrate-parachain-template/)
repository. The parachain template is generated directly at each Polkadot
release branch from the [Node Template in
Substrate](https://github.com/paritytech/substrate/tree/master/bin/node-template)
Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/bin/node-template)
upstream
It is usually best to use the stand-alone version to start a new project. All
bugs, suggestions, and feature requests should be made upstream in the
[Substrate](https://github.com/paritytech/substrate/tree/master/bin/node-template)
[Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate)
repository.
## Getting Started
@@ -186,7 +186,7 @@ template and note the following:
The runtime in this project is constructed using many FRAME pallets that ship
with [the Substrate
repository](https://github.com/paritytech/substrate/tree/master/frame) and a
repository](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame) and a
template pallet that is [defined in the
`pallets`](./pallets/template/src/lib.rs) directory.
@@ -221,5 +221,5 @@ the correct dependencies, activate direnv `direnv allow`.
### Docker
Please follow the [Substrate Docker instructions
here](https://github.com/paritytech/substrate/blob/master/docker/README.md) to
here](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/docker/README.md) to
build the Docker container with the Substrate Node Template binary.
@@ -179,7 +179,7 @@ If you want to guarantee that your build works on your computer as you update Ru
use a specific Rust nightly version that is known to be compatible with the version of Substrate they are using; this
version will vary from project to project and different projects may use different mechanisms to communicate this
version to developers. For instance, the Polkadot client specifies this information in its [release
notes](https://github.com/paritytech/polkadot/releases).
notes](https://github.com/paritytech/polkadot-sdk/releases).
```bash
# Specify the specific nightly toolchain in the date below:
+1 -1
View File
@@ -50,7 +50,7 @@ impl SubstrateCli for Cli {
}
fn support_url() -> String {
"https://github.com/paritytech/substrate/issues/new".into()
"https://github.com/paritytech/polkadot-sdk/issues/new".into()
}
fn copyright_start_year() -> i32 {
+1 -1
View File
@@ -159,7 +159,7 @@ ambiguity despite using block number instead of a hash. A collection of **votes*
a Commitment and a collection of signatures is going to be called **Signed Commitment**. A valid
(see later for the rules) Signed Commitment is also called a **BEEFY Justification** or
**BEEFY Finality Proof**. For more details on the actual data structures please see
[BEEFY primitives definitions](https://github.com/paritytech/substrate/tree/master/primitives/beefy/src).
[BEEFY primitives definitions](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/primitives/beefy/src).
A **round** is an attempt by BEEFY validators to produce a BEEFY Justification. **Round number**
is simply defined as a block number the validators are voting for, or to be more precise, the
@@ -12,8 +12,8 @@ LABEL description="Multistage Docker image for Substrate: a platform for web3" \
io.parity.image.authors="chevdor@gmail.com, devops-team@parity.io" \
io.parity.image.vendor="Parity Technologies" \
io.parity.image.description="Substrate is a next-generation framework for blockchain innovation 🚀" \
io.parity.image.source="https://github.com/paritytech/polkadot/blob/${VCS_REF}/docker/substrate_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot/"
io.parity.image.source="https://github.com/paritytech/polkadot-sdk/blob/${VCS_REF}/substrate/docker/substrate_builder.Dockerfile" \
io.parity.image.documentation="https://github.com/paritytech/polkadot-sdk"
COPY --from=builder /substrate/target/release/substrate /usr/local/bin
COPY --from=builder /substrate/target/release/subkey /usr/local/bin
+1 -1
View File
@@ -1,7 +1,7 @@
# Substrate Node Template Release Process
## This release process has to be run in a github checkout Substrate directory with your work committed into
`https://github.com/paritytech/substrate/`, because the build script will check the existence of your current git commit
`https://github.com/paritytech/polkadot-sdk/`, because the build script will check the existence of your current git commit
ID in the remote repository.
Assume you are in root directory of Substrate. Run:
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/bags-list) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]:
@@ -608,7 +608,7 @@ fn expand_functions(def: &EnvDef, expand_blocks: bool, host_state: TokenStream2)
let not_deprecated = f.not_deprecated;
// wrapped host function body call with host function traces
// see https://github.com/paritytech/substrate/tree/master/frame/contracts#host-function-tracing
// see https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/contracts#host-function-tracing
let wrapped_body_with_trace = {
let trace_fmt_args = params.clone().filter_map(|arg| match arg {
syn::FnArg::Receiver(_) => None,
+1 -1
View File
@@ -457,7 +457,7 @@ impl<T: Config> Pallet<T> {
// Note that a signed extension can also indicate that a particular data must be present in the
// _signing payload_ of a transaction by providing an implementation for the `additional_signed`
// method. This example will not cover this type of extension. See `CheckSpecVersion` in
// [FRAME System](https://github.com/paritytech/substrate/tree/master/frame/system#signed-extensions)
// [FRAME System](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/system#signed-extensions)
// for an example.
//
// Using the extension, you can add some hooks to the life cycle of each transaction. Note that by
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/fast-unstake) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
+1 -1
View File
@@ -17,7 +17,7 @@
//! > Made with *Substrate*, for *Polkadot*.
//!
//! [![github]](https://github.com/paritytech/substrate/frame/fast-unstake) -
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/scheduler) -
//! [![polkadot]](https://polkadot.network)
//!
//! [polkadot]: https://img.shields.io/badge/polkadot-E6007A?style=for-the-badge&logo=polkadot&logoColor=white
+1 -1
View File
@@ -73,7 +73,7 @@ pub mod pallet {
### Example from the FRAME
The [Session module](https://github.com/paritytech/substrate/blob/master/frame/session/src/lib.rs) uses
The [Session module](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/frame/session/src/lib.rs) uses
the Timestamp module for session management.
## Related Modules
@@ -6,7 +6,7 @@ description = "Primitives for Sassafras consensus"
edition = "2021"
license = "Apache-2.0"
homepage = "https://substrate.io"
repository = "https://github.com/paritytech/substrate/"
repository = "https://github.com/paritytech/polkadot-sdk/"
documentation = "https://docs.rs/sp-consensus-sassafras"
readme = "README.md"
publish = false
@@ -7,6 +7,6 @@ to significant changes.
Depends on upstream experimental feature: `bandersnatch-experimental`.
These structs were mostly extracted from the main SASSAFRAS protocol PR: https://github.com/paritytech/substrate/pull/11879.
These structs were mostly extracted from the main SASSAFRAS protocol PR: https://github.com/paritytech/polkadot-sdk/pull/1336.
Tracking issue: https://github.com/paritytech/polkadot-sdk/issues/41
+2 -2
View File
@@ -21,7 +21,7 @@
//! Substrate is a Rust framework for building blockchains in a modular and extensible way. While in
//! itself un-opinionated, it is the main engine behind the Polkadot ecosystem.
//!
//! [![github]](https://github.com/paritytech/substrate/) - [![polkadot]](https://polkadot.network)
//! [![github]](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/) - [![polkadot]](https://polkadot.network)
//!
//! This crate in itself does not contain any code and is just meant ot be a documentation hub for
//! substrate-based crates.
@@ -157,7 +157,7 @@
//! through which Polkadot can be utilized is by building "parachains", blockchains that are
//! connected to Polkadot's shared security.
//!
//! To build a parachain, one could use [`Cumulus`](https://github.com/paritytech/cumulus/), the
//! To build a parachain, one could use [`Cumulus`](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus), the
//! library on top of Substrate, empowering any substrate-based chain to be a Polkadot parachain.
//!
//! ## Where To Go Next?