Skip to content

Commit

Permalink
Fix deps for local docs build for Rust 1.75.0 (paritytech#2896)
Browse files Browse the repository at this point in the history
- Fix docs deps build issue
(servo/rust-smallvec#327) (Please forgive me
and LMK if there are processes I need to follow for the bump a dep here
I am not aware of).
- Fix links for `meta_contributing` docs, internal and external.
- `cargo +nightly fmt` for `/docs/...` files
  • Loading branch information
nuke-web3 authored Jan 10, 2024
1 parent ce4e549 commit 01ea45c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 15 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/mermaid/polkadot_sdk_parachain.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ flowchart LR
end

FRAME -.-> ParachainRuntime
Substrate[Substrate Node Libraries] -.-> ParachainNoe
Substrate[Substrate Node Libraries] -.-> ParachainNode

CumulusC[Cumulus Node Libraries] -.-> ParachainNode
CumulusR[Cumulus Runtime Libraries] -.-> ParachainRuntime
2 changes: 1 addition & 1 deletion docs/sdk/src/guides/your_first_pallet/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ pub mod pallet {
// ensure sender has enough balance, and if so, calculate what is left after `amount`.
let sender_balance = Balances::<T>::get(&sender).ok_or("NonExistentAccount")?;
if sender_balance < amount {
return Err("InsufficientBalance".into())
return Err("InsufficientBalance".into());
}
let reminder = sender_balance - amount;

Expand Down
23 changes: 12 additions & 11 deletions docs/sdk/src/meta_contributing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
//! > high level tutorial. They should be explained in the rust-doc of the corresponding type or
//! > macro.
//!
//! 2. 🧘 Less is More: For reasons mentioned [above](#crate::why-rust-docs), the more concise this
//! crate is, the better.
//! 2. 🧘 Less is More: For reasons mentioned [above](#why-rust-docs), the more concise this crate
//! is, the better.
//! 3. √ Don’t Repeat Yourself – DRY: A summary of the above two points. Authors should always
//! strive to avoid any duplicate information. Every concept should ideally be documented in
//! *ONE* place and one place only. This makes the task of maintaining topics significantly
Expand All @@ -69,8 +69,7 @@
//! > what topics are already covered in this crate, and how you can build on top of the information
//! > that they already pose, rather than repeating yourself**.
//!
//! For more details about documenting guidelines, see:
//! <https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/DOCUMENTATION_GUIDELINES.md#L23>
//! For more details see the [latest documenting guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/DOCUMENTATION_GUIDELINES.md).
//!
//! #### Example: Explaining `#[pallet::call]`
//!
Expand Down Expand Up @@ -133,14 +132,16 @@
//! compromise, but in the long term, we should work towards finding a way to maintain different
//! revisions of this crate.
//!
//! ## How to Build
//! ## How to Develop Locally
//!
//! To build this crate properly, with with right HTML headers injected, run:
//! To view the docs specific [`crate`] locally for development, including the correct HTML headers
//! injected, run:
//!
//! ```no_compile
//! RUSTDOCFLAGS="--html-in-header $(pwd)/docs/sdk/headers/toc.html" cargo doc -p polkadot-sdk-docs
//! ```sh
//! SKIP_WASM_BUILD=1 RUSTDOCFLAGS="--html-in-header $(pwd)/docs/sdk/headers/toc.html" cargo doc -p polkadot-sdk-docs --no-deps --open
//! ```
//!
//! adding `--no-deps` would speed up the process while development. If even faster build time for
//! docs is needed, you can temporarily remove most of the substrate/cumulus dependencies that are
//! only used for linking purposes.
//! If even faster build time for docs is needed, you can temporarily remove most of the
//! substrate/cumulus dependencies that are only used for linking purposes.
//!
//! For more on local development, see [`crate::reference_docs::development_environment_advice`].

0 comments on commit 01ea45c

Please sign in to comment.