Migrate to mkdocs material

.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+name: Deploy Github Pages 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

.github/workflows/test-build.yml

@@ -0,0 +1,22 @@
+name: Test mkdocs build
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs build

.gitignore

@@ -0,0 +1,2 @@
+.venv
+site

README.md

@@ -1,17 +1,3 @@
-# EthStaker Guides
+# Ethstaker guides
 
-Random documents for the ETHStaker community.
-
-## Guides
-
-- [Guide on how to do monitoring for an Ethereum validator](monitoring.md)
-- [Guide on how to do alerting for an Ethereum validator](alerting.md)
-- [Guide on how to setup a Holeksy testnet node (Nethermind/Lighthouse)](holesky-node.md)
-- [Guide on how to setup a Holeksy testnet node (Reth/Lodestar)](holesky-node-alt.md)
-- [Guide on how to prepare a staking machine for the Merge](prepare-for-the-merge.md)
-- [Guide on how to perform a voluntary exit for your validator](voluntary-exit.md)
-- [Guide on How to Migrate to a Larger Disk for an Ethereum Validator](migrating-to-a-larger-disk.md)
-
-## MEV
-
-- [MEV relay list](MEV-relay-list.md)
+This is the build repo for assorted Ethstaker guides, using [mkdocs material](https://squidfunk.github.io/mkdocs-material/).

docs/README.md

@@ -0,0 +1,17 @@
+# EthStaker Guides
+
+Random documents for the ETHStaker community.
+
+## Guides
+
+- [Guide on how to do monitoring for an Ethereum validator](monitoring.md)
+- [Guide on how to do alerting for an Ethereum validator](alerting.md)
+- [Guide on how to setup a Holeksy testnet node (Nethermind/Lighthouse)](holesky-node.md)
+- [Guide on how to setup a Holeksy testnet node (Reth/Lodestar)](holesky-node-alt.md)
+- [Guide on how to prepare a staking machine for the Merge](prepare-for-the-merge.md)
+- [Guide on how to perform a voluntary exit for your validator](voluntary-exit.md)
+- [Guide on How to Migrate to a Larger Disk for an Ethereum Validator](migrating-to-a-larger-disk.md)
+
+## MEV
+
+- [MEV relay list](MEV-relay-list.md)

docs/home-router/overview.md

@@ -0,0 +1,48 @@
+# The Problem
+
+When running an Ethereum node at home, the ISP's router may "buckle" under the sheer number of connections your node creates.
+
+The symptom for this is typically that Internet access slows to a crawl or fails entirely, but recovers for a while when the
+route is rebooted, and/or the Ethereum node is shut off.
+
+![Network amxiety](../images/home-router/cheems-network.png)
+
+*Above: Typical scenario with undersized ISP router*
+
+# The Solution
+
+Place the ISP's router into "bridge mode", and run your own router. The ISP's router in bridge mode no longer understands
+IP addresses, does not provide WiFi, and generally has no clue what a "connection" is.
+
+Your own router handles connections and WiFi, and will handle the Ethereum node with ease.
+
+The ISP's router is kept in the setup so that the ISP has a clear "demarc" - Demarcation Point - and will continue to
+provide good support for issues with the line. This also simplifies setup.
+
+## Which home router?
+
+Most home routers in the USD 200+ range should do great. Two models are particularly well liked, the
+[Netgear RS line](https://www.netgear.com/home/wifi/routers/listing-filter/ax-wifi7/), and the
+[Ubiquity Dream Machine Pro](https://techspecs.ui.com/unifi/unifi-cloud-gateways/udm-pro).
+
+We've documented Netgear, and are interested in receiving screen shots and a walk-through for Ubiquity. If you're feeling helpful, get in touch on
+[Ethstaker Discord](https://discord.gg/ethstaker)
+
+> Caution: The Ubiquity Dream Router [reportedly](https://www.reddit.com/r/Ubiquiti/comments/126pi7q/dream_router_with_xfinity_gateway_doesnt_work/)
+does not work well, and cannot handle GBit Internet. If you have one on Comcast in bridge mode, and it works for you, please get in touch so we can
+document it, including minimum firmware version, any specific settings to make it work, and throughput restrictions.
+
+## Do all ISPs support bridge mode?
+
+Not all ISPs do.
+
+We've tested successfully on:
+
+- Comcast (USA)
+- NOS (Portugal)
+
+These ISPs do not have bridge mode, or "true bridge mode":
+
+- AT&T Fiber (USA). A community solution is to use an Ubiquity Dream Machine Pro, a
+[custom fiber transceiver](https://pon.wiki/guides/masquerade-as-the-att-inc-bgw320-500-505-on-xgs-pon-with-the-bfw-solutions-was-110/),
+and for WiFi, Ubiquity APs. If you have this working or are interested in getting it to work, please get in touch.

mkdocs.yml

@@ -0,0 +1,15 @@
+site_name: Ethstaker Guides
+#site_url: https://guides.ethstaker.cc  # Hoped-for CNAME in future
+site_url: https://eth-educators.github.io/ethstaker-guides/
+theme:
+  name: material
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+plugins:
+  - search
+nav:
+  - Home: README.md
+  - Better Router:
+    - Overview: home-router/overview.md