ci: Check-docs for all workspace packages by shinigami-777 · Pull Request #2158 · bitcoindevkit/bdk

shinigami-777 · 2026-03-15T21:16:05Z

Description

This PR adds a script (ci/check-docs.sh) that checks documentation builds for all workspace packages. The check-docs job is added to the workflow file cont_integration.yml that calls the check-docs.sh script. A justfile recipe just doc added to execute ci/check-docs.sh .

Notes to the reviewers

Currently the bdk_chain and bdk_core checks are failing due to the following errors:

Changelog notice

Checklists

All Submissions:

I followed the contribution guidelines

New Features:

I've added tests for the new feature
I've added docs for the new feature

Bugfixes:

This pull request breaks the existing API
I've added tests to reproduce the issue which are now passing
I'm linking the issue being fixed by this PR

evanlinjin · 2026-03-16T03:05:33Z

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

ValuedMammal · 2026-03-16T14:52:10Z

@shinigami-777 Can you add a commit addressing the check-docs failures? I recommend removing the redundant explicit link targets in keychain_txout.rs for types that are already in scope (i.e. bitcoin::Script). Then in spk_client.rs update the docs with a valid link to the KeychainTxOutIndex type.

shinigami-777 · 2026-03-16T15:55:36Z

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

I have added some doc changes to the CONTRIBUTING.md in this commit.

shinigami-777 · 2026-03-16T15:59:40Z

Updated keychain_txout.rs and spk_client.rs. Now all doc checks are successful.

oleonardolima

Thanks for working on this one!

I left some comments as I don't see use for a new check-docs.sh file we should probably just call the cargo commands directly. Let's see what other thinks about it.

Also, you could probably squash it into two commits, something like this:

ci: add new check-docs job and recipe in justfile
fix(docs): in keychain_txout.rs and spk_client.rs

oleonardolima · 2026-03-16T23:17:13Z

justfile

@@ -57,3 +58,7 @@ _test-testenv:

 # Run pre-push suite: format, check, and test
 pre-push: fmt check test


nit: it's also a good idea to add the doc to pre-push too.

I added the doc for pre-push in this commit.

oleonardolima · 2026-03-16T23:17:54Z

ci/check-docs.sh

+#!/usr/bin/env bash
+
+set -e
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m'
+
+echo "Checking documentation for all workspace packages..."
+
+PACKAGES=(
+    "bdk_chain"
+    "bdk_core"
+    "bdk_file_store"
+    "bdk_electrum"
+    "bdk_esplora"
+    "bdk_bitcoind_rpc"
+    "bdk_testenv"
+)
+
+FAILED=0
+
+for package in "${PACKAGES[@]}"; do
+    echo "Checking for ${package}..."
+
+    if RUSTDOCFLAGS='-D warnings' cargo rustdoc -p "${package}" --all-features -- -D warnings; then
+        echo -e "${GREEN}✓ ${package} docs OK${NC}"
+    else
+        echo -e "${RED}✗ ${package} docs FAILED${NC}"
+        FAILED=1
+    fi
+    echo ""
+done
+
+if [ $FAILED -eq 1 ]; then
+    echo -e "${RED}Documentation check failed for one or more packages${NC}"
+    exit 1
+else
+    echo -e "${GREEN}All documentation checks passed!${NC}"
+    exit 0
+fi


@shinigami-777 What's the benefit for having this instead of just calling RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps ?

Removed ci/check-docs.sh. I did the same using RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps.

oleonardolima · 2026-03-16T23:31:26Z

crates/core/src/spk_client.rs

    /// Sync revealed script pubkeys obtained from a
-    /// [`KeychainTxOutIndex`](../../bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.
-    /// html).
+    /// [`KeychainTxOutIndex`](https://docs.rs/bdk_chain/0.23.2/bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).


nit: it's best to use latest

Suggested change

/// [`KeychainTxOutIndex`](https://docs.rs/bdk_chain/0.23.2/bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).

/// [`KeychainTxOutIndex`](https://docs.rs/bdk_chain/latest/bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).

oleonardolima · 2026-03-16T23:32:23Z

.github/workflows/cont_integration.yml

+          override: true
+          cache: true
+      - name: Check docs
+        run: ./ci/check-docs.sh


As I mentioned below I don't think we need another file, calling RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps here and in justfile is much better.

Changed to just calling RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps.

shinigami-777 · 2026-03-18T22:01:36Z

@oleonardolima Thanks for reviewing. I have made the changes and squashed them in 2 commits: c4b8e93 and 1d1e985

shinigami-777 requested review from evanlinjin and oleonardolima as code owners March 15, 2026 21:16

github-project-automation bot added this to BDK Chain Mar 15, 2026

shinigami-777 changed the title ~~Check docs~~ ci: Check-docs for all workspace packages Mar 15, 2026

ValuedMammal assigned shinigami-777 Mar 16, 2026

ValuedMammal added documentation Improvements or additions to documentation tests github_actions Pull requests that update GitHub Actions code labels Mar 16, 2026

ValuedMammal moved this to Needs Review in BDK Chain Mar 16, 2026

ValuedMammal linked an issue Mar 16, 2026 that may be closed by this pull request

Check cargo rustdoc for all workspace members #2152

Open

10 tasks

oleonardolima added this to the Chain 0.24.0 milestone Mar 16, 2026

oleonardolima reviewed Mar 16, 2026

View reviewed changes

ci: add new check-docs job, justfile recipe and documentation

c4b8e93

shinigami-777 force-pushed the check-docs branch from ad4c568 to c4b8e93 Compare March 18, 2026 21:44

fix(docs): in keychain_txout.rs and spk_client.rs

1d1e985

		@@ -57,3 +58,7 @@ _test-testenv:

		# Run pre-push suite: format, check, and test
		pre-push: fmt check test

	/// [`KeychainTxOutIndex`](https://docs.rs/bdk_chain/0.23.2/bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).
	/// [`KeychainTxOutIndex`](https://docs.rs/bdk_chain/latest/bdk_chain/indexer/keychain_txout/struct.KeychainTxOutIndex.html).

Conversation

shinigami-777 commented Mar 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

New Features:

Bugfixes:

Uh oh!

evanlinjin commented Mar 16, 2026

Uh oh!

ValuedMammal commented Mar 16, 2026

Uh oh!

shinigami-777 commented Mar 16, 2026

Uh oh!

shinigami-777 commented Mar 16, 2026

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

oleonardolima Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

shinigami-777 Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

oleonardolima Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

shinigami-777 Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

oleonardolima Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

oleonardolima Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

shinigami-777 Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

shinigami-777 commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shinigami-777 commented Mar 15, 2026 •

edited

Loading