Skip to content

Commit 3dbd1e3

Browse files
DavidLiedleclaude
andcommitted
Initial scaffold: book.toml, SUMMARY, deploy workflow, preface, intro, chapter stubs
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent e68c699 commit 3dbd1e3

20 files changed

Lines changed: 267 additions & 0 deletions

.github/workflows/deploy.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy mdBook to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- name: Setup mdBook
25+
uses: peaceiris/actions-mdbook@v2
26+
with:
27+
mdbook-version: 'latest'
28+
29+
- name: Build book
30+
run: mdbook build
31+
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v5
34+
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: ./book
39+
40+
deploy:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
steps:
47+
- name: Deploy to GitHub Pages
48+
id: deployment
49+
uses: actions/deploy-pages@v4

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Mesh Networking for Mortals
2+
3+
**A 2026 survey of mesh networking, scoped for the working engineer.**
4+
5+
**[Read online at cloudstreet-dev.github.io/Mesh-Networking-for-Mortals](https://cloudstreet-dev.github.io/Mesh-Networking-for-Mortals/)**
6+
7+
## About This Book
8+
9+
The available literature on mesh networking splits into two unhelpful piles: academic papers that assume you've read every prior academic paper, and project-website pitches that assume you're already sold. There is almost nothing in between for the engineer who has heard of half these projects, doesn't know how they compare, and wants an honest survey before they commit a weekend to playing with one.
10+
11+
This book is that survey, scoped to 2026.
12+
13+
The reader is a competent developer who has shipped real products. They know what TCP/IP is. They've maybe heard of Meshtastic from a maker friend, vaguely remember that cjdns was a thing in the 2010s, use Tailscale at work, and aren't sure whether any of those are actually the same kind of thing. They want to know which projects are alive in 2026, what each one is structurally good at, what it gets wrong, and which one to install on a Raspberry Pi this weekend if they want to actually feel mesh networking in their hands.
14+
15+
## About CloudStreet
16+
17+
CloudStreet is a catalog of short, opinionated technical books on topics that working engineers ought to understand and mostly don't. Each book is written to be read in a weekend and to leave the reader more dangerous than they were on Friday.
18+
19+
## AI Authorship
20+
21+
This book is written by Claude Opus 4.7 (Anthropic), with editorial direction and project management from the CloudStreet team. The byline is the model's own. We disclose this plainly because the alternative is dishonest, and because the work is good enough to defend on its merits.
22+
23+
## Building Locally
24+
25+
```sh
26+
cargo install mdbook
27+
mdbook serve --open
28+
```
29+
30+
## Deploying
31+
32+
Pushes to `main` build the book and deploy to GitHub Pages via the workflow at `.github/workflows/deploy.yml` (peaceiris/actions-mdbook + actions/deploy-pages).
33+
34+
## License
35+
36+
CC0 1.0 Universal — public domain dedication. Take it, fork it, ship it, claim it as your own. See [LICENSE](LICENSE).

book.toml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[book]
2+
title = "Mesh Networking for Mortals"
3+
authors = ["Claude Opus 4.7"]
4+
description = "A 2026 survey of mesh networking that doesn't expect you to have read every academic paper. Reticulum, Meshtastic, MeshCore, Yggdrasil, cjdns, Scuttlebutt, Briar, and the mesh VPNs — what each is good for, what it gets wrong, which are worth your weekend."
5+
language = "en"
6+
src = "src"
7+
8+
[build]
9+
build-dir = "book"
10+
11+
[output.html]
12+
git-repository-url = "https://github.com/cloudstreet-dev/Mesh-Networking-for-Mortals"
13+
edit-url-template = "https://github.com/cloudstreet-dev/Mesh-Networking-for-Mortals/edit/main/{path}"
14+
site-url = "/Mesh-Networking-for-Mortals/"
15+
default-theme = "navy"
16+
preferred-dark-theme = "navy"
17+
18+
[output.html.fold]
19+
enable = true
20+
level = 0
21+
22+
[output.html.search]
23+
enable = true
24+
limit-results = 30
25+
teaser-word-count = 30
26+
use-boolean-and = true
27+
boost-title = 2
28+
boost-hierarchy = 1
29+
boost-paragraph = 1
30+
expand = true
31+
heading-split-level = 3

src/SUMMARY.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Summary
2+
3+
[Preface](preface.md)
4+
[Introduction](introduction.md)
5+
6+
---
7+
8+
# Part I: Orientation
9+
10+
- [What "Mesh Networking" Even Means](ch01-what-mesh-even-means.md)
11+
- [The Physical Layer Decides A Lot](ch02-physical-layer.md)
12+
- [The Routing Problem](ch03-routing-problem.md)
13+
14+
# Part II: The LoRa Family
15+
16+
- [Meshtastic](ch04-meshtastic.md)
17+
- [MeshCore](ch05-meshcore.md)
18+
- [Reticulum](ch06-reticulum.md)
19+
20+
# Part III: IP-Layer Meshes
21+
22+
- [Yggdrasil](ch07-yggdrasil.md)
23+
- [The Hyperboria Story](ch08-hyperboria.md)
24+
25+
# Part IV: Adjacent Shapes
26+
27+
- [Scuttlebutt and the Gossip Family](ch09-scuttlebutt.md)
28+
- [Briar, Bitchat, and the Bluetooth Family](ch10-briar-bitchat.md)
29+
- [Mesh VPNs Are A Different Thing](ch11-mesh-vpns.md)
30+
31+
# Part V: Practice
32+
33+
- [Pick One This Weekend](ch12-pick-one.md)
34+
35+
---
36+
37+
[Acknowledgments](acknowledgments.md)
38+
[License](license.md)

src/acknowledgments.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Acknowledgments
2+
3+
Thanks to **Georgiy Treyvus**, the CloudStreet PM who keeps the backlog and who decided this book belonged on it.

src/ch01-what-mesh-even-means.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# what mesh even means
2+
3+
*Coming soon.*

src/ch02-physical-layer.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# physical layer
2+
3+
*Coming soon.*

src/ch03-routing-problem.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# routing problem
2+
3+
*Coming soon.*

src/ch04-meshtastic.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# meshtastic
2+
3+
*Coming soon.*

src/ch05-meshcore.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# meshcore
2+
3+
*Coming soon.*

0 commit comments

Comments
 (0)