feat: testable book-of-bdk

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+  - package-ecosystem: "cargo"
+    directory: "/tests" # point this towards a Cargo.toml directory
+    schedule:
+      # Check for updates to Rust dependencies every week
+      interval: "weekly"

.github/workflows/check-links.yml

@@ -0,0 +1,25 @@
+name: Markdown Links Check
+# runs every monday at 9 am
+on:
+  schedule:
+    - cron: "0 9 * * 1"
+  workflow_dispatch: null
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # checks all markdown files from /book including all subfolders
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          folder-path: 'book/'
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        # checks all markdown files from root but ignores subfolders
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          max-depth: 0

.github/workflows/test.yaml

@@ -0,0 +1,28 @@
+name: Tests
+on:
+  push:
+    branches: [ master, '[0-9]+.[0-9]+.[0-9]+', '[0-9]+.[0-9]+.[0-9]+-[A-Za-z0-9]+' ]
+  pull_request:
+    branches: [ master, '[0-9]+.[0-9]+.[0-9]+', '[0-9]+.[0-9]+.[0-9]+-[A-Za-z0-9]+' ]
+  # runs every monday at 9 am
+  schedule:
+    - cron: "0 9 * * 1"
+  workflow_dispatch: null
+
+jobs:
+  code-samples:
+    name: Test code samples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+      - name: Generate harness
+        working-directory: ./tests
+        run: ./generate.sh
+      - name: Test code samples
+        working-directory: ./tests
+        run: cargo test

.gitignore

@@ -1,3 +1,9 @@
 node_modules/
 cache/
 dist/
+
+# test stuff
+tests/Cargo.lock
+tests/target
+tests/src
+tests/config.txt

book/getting-started.md

@@ -1,26 +1,37 @@
 # Getting Started
+
 ### Install Rust
+
 See the Rust ["Getting Started"] page to install the Rust development tools.
 
 ### Using BDK in a Rust project
+
 Follow these steps to use BDK in your own rust project with the async `esplora` blockchain client.
 
 :::tip
 For now use the latest `master` branch versions of BDK crates.
+As an example, for BDK:
+
+```shell
+cargo add bdk --git "https://github.com/notmandatory/bdk.git"
+```
 :::
 
 1. Create a new Rust project:
+
 ```shell
 cargo init my_bdk_app
 cd my_bdk_app
 ```
 
 2. Add `bdk` to your `Cargo.toml` file. Find the latest `bdk@1` release on [`crates.io`](https://crates.io/crates/bdk/versions), for example:
+
 ```shell
 cargo add [email protected]
 ```
 
 3. Add other required dependencies:
+
 ```shell
 cargo add [email protected]
 cargo add [email protected]