Merge #2006: refactor: replace examples with focused rustdoc examples

522e441 chore: Remove example_cli (Kyle 🐆)

Pull request description:

  Closes #1973

  The PR is now scoped to the first step of the work discussed in #1973:

  - Remove the unmaintained example binaries in examples/
  - Remove the related workspace members from Cargo.toml
  - Clean up docs and CI references that pointed to the removed examples

ACKs for top commit:
  ValuedMammal:
    ACK 522e441

Tree-SHA512: 217bbe23c0798903046eaf3f8638099d721c59bc26902fa5d9c3a0e3c3bcc6738b9a7e9b6e6ca82e3c1758aaffd69bec3e91cf00e5a6bf7e1da7c53cf23f1288

Author: ValuedMammal

.github/workflows/cont_integration.yml

@@ -49,8 +49,8 @@ jobs:
         env:
           MATRIX_RUST_VERSION: ${{ matrix.rust.version }}
         run: |
-            cargo build --workspace --exclude 'example_*' ${{ matrix.features }}
-            cargo test --workspace --exclude 'example_*' ${{ matrix.features }}
+            cargo build --workspace ${{ matrix.features }}
+            cargo test --workspace ${{ matrix.features }}
 
   check-no-std:
     needs: prepare
@@ -141,32 +141,6 @@ jobs:
       - name: Clippy
         run: cargo clippy --all-features --all-targets -- -D warnings
 
-  build-examples:
-    needs: prepare
-    name: Build & Test Examples
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        example-dir:
-          - example_cli
-          - example_bitcoind_rpc_polling
-          - example_electrum
-          - example_esplora
-    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: Build
-        working-directory: examples/${{ matrix.example-dir }}
-        run: cargo build
-
   check-docs:
     needs: prepare
     name: Check documentation errors

Cargo.toml

@@ -8,10 +8,6 @@ members = [
     "crates/esplora",
     "crates/bitcoind_rpc",
     "crates/testenv",
-    "examples/example_cli",
-    "examples/example_electrum",
-    "examples/example_esplora",
-    "examples/example_bitcoind_rpc_polling",
 ]
 
 [workspace.package]

README.md

@@ -41,13 +41,6 @@ The workspace in this repository contains several crates in the `/crates` direct
 
 The [`bdk_wallet`] repository and crate contains a higher level `Wallet` type that depends on the above lower-level mechanism crates.
 
-Fully working examples of how to use these components are in `/examples`:
-
-- [`example_cli`](examples/example_cli): Library used by the `example_*` crates. Provides utilities for syncing, showing the balance, generating addresses and creating transactions without using the bdk_wallet `Wallet`.
-- [`example_electrum`](examples/example_electrum): A command line Bitcoin wallet application built on top of `example_cli` and the `electrum` crate. It shows the power of the bdk tools (`chain` + `file_store` + `electrum`), without depending on the main `bdk_wallet` library.
-- [`example_esplora`](examples/example_esplora): A command line Bitcoin wallet application built on top of `example_cli` and the `esplora` crate. It shows the power of the bdk tools (`chain` + `file_store` + `esplora`), without depending on the main `bdk_wallet` library.
-- [`example_bitcoind_rpc_polling`](examples/example_bitcoind_rpc_polling): A command line Bitcoin wallet application built on top of `example_cli` and the `bitcoind_rpc` crate. It shows the power of the bdk tools (`chain` + `file_store` + `bitcoind_rpc`), without depending on the main `bdk_wallet` library.
-
 [`rust-miniscript`]: https://github.com/rust-bitcoin/rust-miniscript
 [`rust-bitcoin`]: https://github.com/rust-bitcoin/rust-bitcoin
 [`esplora-client`]: https://docs.rs/esplora-client/

crates/electrum/src/lib.rs

@@ -11,9 +11,6 @@
 //! where the range of possibly used scripts is not known. In this case it is necessary to scan all
 //! keychain scripts until a number (the "stop gap") of unused scripts is discovered.
 //!
-//! Refer to [`example_electrum`] for a complete example.
-//!
-//! [`example_electrum`]: https://github.com/bitcoindevkit/bdk/tree/master/examples/example_electrum
 //! [`SyncResponse`]: bdk_core::spk_client::SyncResponse
 //! [`FullScanResponse`]: bdk_core::spk_client::FullScanResponse
 #![cfg_attr(coverage_nightly, feature(coverage_attribute))]

crates/esplora/README.md

@@ -41,8 +41,6 @@ use bdk_esplora::EsploraExt;
 use bdk_esplora::EsploraAsyncExt;
 ```
 
-For full examples, refer to [`example_wallet_esplora_blocking`](https://github.com/bitcoindevkit/bdk/tree/master/examples/example_wallet_esplora_blocking) and [`example_wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/examples/example_wallet_esplora_async).
-
 [`esplora-client`]: https://docs.rs/esplora-client/
 [`bdk_chain`]: https://docs.rs/bdk-chain/
 [`EsploraExt`]: crate::EsploraExt