From a6a4f3aee987f5155132aa3be1ac06e94f9c4244 Mon Sep 17 00:00:00 2001 From: qlrd Date: Wed, 3 Jun 2026 15:26:14 -0300 Subject: [PATCH 1/2] docs: added `doc(html_logo_url)` attribute at beggining of each module --- crates/kdk-entropy/src/lib.rs | 1 + crates/kdk-zeroize/src/lib.rs | 1 + 2 files changed, 2 insertions(+) diff --git a/crates/kdk-entropy/src/lib.rs b/crates/kdk-entropy/src/lib.rs index 20b4420a..eb002769 100644 --- a/crates/kdk-entropy/src/lib.rs +++ b/crates/kdk-entropy/src/lib.rs @@ -12,6 +12,7 @@ //! guarantees, this one inherits. #![no_std] +#![doc(html_logo_url = "https://qlrd.github.io/kdk/logo.png")] use kdk_zeroize::SensitiveBytes; diff --git a/crates/kdk-zeroize/src/lib.rs b/crates/kdk-zeroize/src/lib.rs index de9a50b7..04f89c06 100644 --- a/crates/kdk-zeroize/src/lib.rs +++ b/crates/kdk-zeroize/src/lib.rs @@ -20,6 +20,7 @@ //! through every downstream crate. #![no_std] +#![doc(html_logo_url = "https://qlrd.github.io/kdk/logo.png")] mod sensitive; From 63299098492054772c98a34542cbf2c6a48358b1 Mon Sep 17 00:00:00 2001 From: qlrd Date: Wed, 3 Jun 2026 15:26:27 -0300 Subject: [PATCH 2/2] ci: updated landing page --- .github/workflows/docs.yml | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 493a5d81..91612369 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -38,37 +38,25 @@ jobs: - name: Build rustdoc run: cargo doc --workspace --no-deps - - name: Build landing index + copy logo + disable Jekyll + - name: Copy logo + write minimal index + disable Jekyll run: | - # Copy the project logo so it lands at /logo.png on gh-pages - # and can be referenced from the landing page. + # Logo at /logo.png — referenced from every crate via + # `#![doc(html_logo_url = "https://qlrd.github.io/kdk/logo.png")]`. cp assets/logo.png target/doc/logo.png - # List every documented crate by scanning `target/doc/*/`. - # A real crate dir contains an `index.html`; auxiliary dirs - # (`search.index/`, `static.files/`, `src/`, etc.) don't. + # Minimal index — bare list of documented crates. Each crate + # page already renders the KDK logo in its sidebar via + # `html_logo_url`, so this page only needs to point at them. cat > target/doc/index.html <<'HEAD' - KDK — API docs - - -

Krust Development Kit

-

Rust toolkit for Krux-style Bitcoin signing firmware.

-

Documented crates:

+ KDK