Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix links to implementers' guide #1865

Merged
merged 6 commits into from
Oct 12, 2023
Merged

Fix links to implementers' guide #1865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
81828f4
Fix implementers guide links
antonva Oct 12, 2023
48c7a04
Use polkadot-sdk url for implementers' guide links
antonva Oct 12, 2023
88f6458
Add link to pvf host and workers
antonva Oct 12, 2023
f2bb8ed
Fix session_info link
antonva Oct 12, 2023
bc91d0b
Change name of overseer link in docs
antonva Oct 12, 2023
f9753a7
Merge branch 'master' into antonva/fix-doc-links
antonva Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion polkadot/node/collation-generation/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ async fn handle_new_activations<Context>(
metrics: Metrics,
) -> crate::error::Result<()> {
// follow the procedure from the guide:
// https://paritytech.github.io/polkadot/book/node/collators/collation-generation.html
// https://paritytech.github.io/polkadot-sdk/book/node/collators/collation-generation.html

if config.collator.is_none() {
return Ok(())
Expand Down
6 changes: 4 additions & 2 deletions polkadot/node/core/pvf/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@
//! The PVF validation host. Responsible for coordinating preparation and execution of PVFs.
//!
//! For more background, refer to the Implementer's Guide: [PVF
//! Pre-checking](https://paritytech.github.io/polkadot/book/pvf-prechecking.html) and [Candidate
//! Validation](https://paritytech.github.io/polkadot/book/node/utility/candidate-validation.html#pvf-host).
//! Pre-checking](https://paritytech.github.io/polkadot-sdk/book/pvf-prechecking.html), [Candidate
//! Validation](https://paritytech.github.io/polkadot-sdk/book/node/utility/candidate-validation.html)
//! and [PVF Host and Workers](https://paritytech.github.io/polkadot-sdk/book/node/utility/pvf-host-and-workers.html).
//!
//!
//! # Entrypoint
//!
Expand Down
5 changes: 4 additions & 1 deletion polkadot/node/network/approval-distribution/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@

//! [`ApprovalDistribution`] implementation.
//!
//! <https://w3f.github.io/parachain-implementers-guide/node/approval/approval-distribution.html>
//! See the documentation on [approval distribution][approval-distribution-page] in the
//! implementers' guide.
//!
//! [approval-distribution-page]: https://paritytech.github.io/polkadot-sdk/book/node/approval/approval-distribution.html

#![warn(missing_docs)]

Expand Down
4 changes: 3 additions & 1 deletion polkadot/node/overseer/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
//! # Overseer
//!
//! `overseer` implements the Overseer architecture described in the
//! [implementers-guide](https://w3f.github.io/parachain-implementers-guide/node/index.html).
//! [implementers' guide][overseer-page].
//! For the motivations behind implementing the overseer itself you should
//! check out that guide, documentation in this crate will be mostly discussing
//! technical stuff.
Expand Down Expand Up @@ -53,6 +53,8 @@
//! . +--------------------+ +---------------------+ .
//! ..................................................................
//! ```
//!
//! [overseer-page]: https://paritytech.github.io/polkadot-sdk/book/node/overseer.html

// #![deny(unused_results)]
// unused dependencies can not work for test and examples at the same time
Expand Down
2 changes: 1 addition & 1 deletion polkadot/node/service/src/relay_chain_selection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//! leaf returned from the chain selection subsystem by calling into other
//! subsystems which yield information about approvals and disputes.
//!
//! [chain-selection-guide]: https://w3f.github.io/parachain-implementers-guide/protocol-chain-selection.html
//! [chain-selection-guide]: https://paritytech.github.io/polkadot-sdk/book/protocol-chain-selection.html

#![cfg(feature = "full-node")]

Expand Down
2 changes: 1 addition & 1 deletion polkadot/roadmap/implementers-guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The implementers' guide is compiled from several source files with [`mdBook`](ht

## Hosted build

This is available [here](https://paritytech.github.io/polkadot/book/).
This is available [here](https://paritytech.github.io/polkadot-sdk/book/).

## Local build

Expand Down
5 changes: 3 additions & 2 deletions polkadot/runtime/parachains/src/session_info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
//! The session info pallet provides information about validator sets
//! from prior sessions needed for approvals and disputes.
//!
//! See <https://w3f.github.io/parachain-implementers-guide/runtime/session_info.html>.

//! See the documentation on [session info][session-info-page] in the implementers' guide.
//!
//! [session-info-page]: https://paritytech.github.io/polkadot-sdk/book/runtime/session_info.html
use crate::{
configuration, paras, scheduler, shared,
util::{take_active_subset, take_active_subset_and_inactive},
Expand Down
Loading