From 1468326b8956f1dcdd2646125d3b22181baee459 Mon Sep 17 00:00:00 2001 From: Mykhailo Chalyi Date: Wed, 1 Apr 2026 23:38:01 +0000 Subject: [PATCH] docs: fix rustdoc guides rendering on docs.rs Add [package.metadata.docs.rs] with all-features = true so feature-gated guides (python_guide, logging_guide) render on docs.rs. Fix Guides section to list all guides with proper link brackets, and add missing live_mounts_guide entry. --- crates/bashkit/Cargo.toml | 4 ++++ crates/bashkit/src/lib.rs | 5 +++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/crates/bashkit/Cargo.toml b/crates/bashkit/Cargo.toml index f7c540d4..fe979349 100644 --- a/crates/bashkit/Cargo.toml +++ b/crates/bashkit/Cargo.toml @@ -94,6 +94,10 @@ python = ["dep:monty"] # Usage: cargo build --features realfs realfs = [] +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docsrs"] + [dev-dependencies] tokio-test = { workspace = true } pretty_assertions = { workspace = true } diff --git a/crates/bashkit/src/lib.rs b/crates/bashkit/src/lib.rs index e8621251..709f9008 100644 --- a/crates/bashkit/src/lib.rs +++ b/crates/bashkit/src/lib.rs @@ -380,9 +380,10 @@ //! # Guides //! //! - [`custom_builtins_guide`] - Creating custom builtins -//! - `python_guide` - Embedded Python (Monty) guide (requires `python` feature) //! - [`compatibility_scorecard`] - Feature parity tracking -//! - `logging_guide` - Structured logging with security (requires `logging` feature) +//! - [`live_mounts_guide`] - Live mount/unmount on running instances +//! - [`python_guide`] - Embedded Python (Monty) guide (requires `python` feature) +//! - [`logging_guide`] - Structured logging with security (requires `logging` feature) //! //! # Resources //!