Skip to content

Commit 0fc22e7

Browse files
authored
docs: fix rustdoc guides rendering on docs.rs (#955)
## Summary - Add `[package.metadata.docs.rs]` with `all-features = true` so feature-gated guide modules (`python_guide`, `logging_guide`) render on docs.rs - Fix Guides section in crate docs: add missing `live_mounts_guide`, convert plain backticks to `[`link brackets`]` for clickable links ## Test plan - [x] `cargo doc --all-features --no-deps` builds cleanly - [x] All 6 guide links render correctly in generated HTML - [x] `cargo test --all-features` passes - [x] `cargo fmt --check` clean - [x] `cargo clippy --all-targets --all-features -- -D warnings` clean
1 parent 5e2e7ea commit 0fc22e7

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

crates/bashkit/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ typescript = ["dep:zapcode-core"]
100100
# Usage: cargo build --features realfs
101101
realfs = []
102102

103+
[package.metadata.docs.rs]
104+
all-features = true
105+
rustdoc-args = ["--cfg", "docsrs"]
106+
103107
[dev-dependencies]
104108
tokio-test = { workspace = true }
105109
pretty_assertions = { workspace = true }

crates/bashkit/src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,9 +380,10 @@
380380
//! # Guides
381381
//!
382382
//! - [`custom_builtins_guide`] - Creating custom builtins
383-
//! - `python_guide` - Embedded Python (Monty) guide (requires `python` feature)
384383
//! - [`compatibility_scorecard`] - Feature parity tracking
385-
//! - `logging_guide` - Structured logging with security (requires `logging` feature)
384+
//! - [`live_mounts_guide`] - Live mount/unmount on running instances
385+
//! - [`python_guide`] - Embedded Python (Monty) guide (requires `python` feature)
386+
//! - [`logging_guide`] - Structured logging with security (requires `logging` feature)
386387
//!
387388
//! # Resources
388389
//!

0 commit comments

Comments
 (0)