From: shinigami-777 <chattopadhyaytamaghna@gmail.com>
Date: Sun, 15 Mar 2026 20:48:52 +0000 (+0530)
Subject: ci: add new check-docs job, justfile recipe and documentation
X-Git-Url: http://internal-gitweb-vhost/parse/src/example_cli/%22https:/source-script.js?a=commitdiff_plain;h=19d1269f814f445b0337d6c66cd694358afede18;p=bdk

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

diff --git a/.github/workflows/cont_integration.yml b/.github/workflows/cont_integration.yml
index 6c8a01ff..8d06dd97 100644
--- a/.github/workflows/cont_integration.yml
+++ b/.github/workflows/cont_integration.yml
@@ -166,3 +166,21 @@ jobs:
       - name: Build
         working-directory: examples/${{ matrix.example-dir }}
         run: cargo build
+
+  check-docs:
+    needs: prepare
+    name: Check documentation errors
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Install Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: ${{ needs.prepare.outputs.rust_version }}
+          override: true
+          cache: true
+      - name: Check docs
+        run: RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a9a90465..699c824c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -87,7 +87,7 @@ Coding Conventions
 ------------------
 
 This codebase uses spaces, not tabs.
-Run `just check` to check formatting, linting, compilation and commit signing, `just fmt` to format code before commiting, and `just test` to run tests for all crates.
+Run `just check` to check formatting, linting, compilation and commit signing, `just fmt` to format code before commiting, `just test` to run tests for all crates, `just pre-push` to run the full pre-push suite before pushing changes and `just doc` to check documentation build warnings and errors for all packages.
 This is also enforced by the CI.
 All public items must be documented. We adhere to the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/about.html) with respect to documentation.
 
diff --git a/justfile b/justfile
index b5ca94d1..7d96010c 100644
--- a/justfile
+++ b/justfile
@@ -3,6 +3,7 @@ alias c := check
 alias f := fmt
 alias t := test
 alias p := pre-push
+alias d := doc
 
 _default:
   @just --list
@@ -57,3 +58,7 @@ _test-testenv:
 
 # Run pre-push suite: format, check, and test
 pre-push: fmt check test
+
+# Check documentation for all workspace packages
+doc:
+   RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps