Merge #147: chore(docs): add missing documentation

bdd9569 chore(docs): add missing documentation (Luis Schwab)
c1d8564 feat(ci): add `Rust Docs` job and update `check` recipe (Luis Schwab)

Pull request description:

  Closes #109.

  This PR adds the missing documentation and a CI job that checks that all objects are documented.

ACKs for top commit:
  oleonardolima:
    tACK bdd9569

Tree-SHA512: 5f31b2b6374ba34b5a4d1e4eee019475ba089b1afc40d3ddb7c7e51f38ad561fba2c0aa6cb306174d3730139fd22b7c7b0d1147ac7af0c36ee4d2f2d878cff98

Author: oleonardolima

.github/workflows/cont_integration.yml

@@ -117,3 +117,26 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-features --all-targets -- -D warnings
+
+  docs:
+    name: Rust Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@v1
+        with:
+            toolchain: stable
+      - name: Rust Cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
+      - name: Build documentation
+        run: cargo doc --all-features --no-deps
+        env:
+          RUSTDOCFLAGS: -D warnings

justfile

@@ -11,11 +11,12 @@ _default:
 build:
    cargo build
 
-# Check code: formatting, compilation, linting, and commit signature
+# Check code: formatting, compilation, linting, doc comments, and commit signature
 check:
    cargo +nightly fmt --all -- --check
    cargo check --all-features --all-targets
    cargo clippy --all-features --all-targets -- -D warnings
+   RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps
    @[ "$(git log --pretty='format:%G?' -1 HEAD)" = "N" ] && \
        echo "\n⚠️  Unsigned commit: BDK requires that commits be signed." || \
        true