doc: Migrate docs to mdBook, slim down the readme

.github/workflows/changelog.yml

@@ -1,18 +1,18 @@
 name: Changelog
 
 on:
-  # pull_request:
-  #   branches:
-  #     - "main"
-  #   paths-ignore: # don't trigger on changes to these files
-  #     - "CHANGELOG.md"
-  # push:
-  #   branches:
-  #     - "main"
-  #   paths-ignore: # don't trigger on changes to these files
-  #     - "CHANGELOG.md"
-  workflow_dispatch:
-    
+  pull_request:
+    branches:
+      - "main"
+    paths-ignore: # don't trigger on changes to these files
+      - "CHANGELOG.md"
+  push:
+    tags:
+      - "*"
+    branches-ignore: # don't trigger on changes to these files
+      - "CHANGELOG.md"
+  workflow_dispatch: {}
+
 
 jobs:
   update-changelog:

.github/workflows/mdbook.yml

@@ -0,0 +1,54 @@
+name: Deploy mdBook to GitHub Pages
+
+on:
+  pull_request:
+  push:
+    tags: [ "v*" ]
+  workflow_dispatch: {}
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Cache Cargo binaries and registry
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin
+            ~/.cargo/registry
+            ~/.cargo/git
+          key: ${{ runner.os }}-cargo-tools-${{ hashFiles('**/book.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-tools-
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: 'latest'
+
+      - name: Install mdBook Table of Contents plugin
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: mdbook-toc
+
+      - name: Install mdBook alerts plugin
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: mdbook-alerts
+
+      - name: Build book
+        run: mdbook build
+
+      - name: Deploy to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: doc/book/

.gitignore

@@ -4,3 +4,6 @@
 .cargo/config.toml
 .editorconfig
 Cargo.lock
+
+# Ignore mdBook build output but keep sources
+doc/book/

CHANGELOG.md

@@ -1,23 +1,36 @@
 # Changelog
 
-Notable changes to this project will be documented in this file.
 
-## [unreleased]
+See [GitHub Releases](https://github.com/philiplinden/bevy_repl/releases) and the [Bevy REPL Book](https://philiplinden.github.io/bevy_repl) for details.
+
+## [0.3.0] - 2025-08-14
 
 ### 📚 Documentation
 
+- Update readme ([`a958b70`](https://github.com/philiplinden/bevy_repl/commit/a958b705327bd2623a7b98854ec84197ab1d9808))
+- Add demo tape to readme ([`ce5a626`](https://github.com/philiplinden/bevy_repl/commit/ce5a62600c6dcc7c4af8d240fc202b7a00da6f06))
+- Readability updates ([`55104ba`](https://github.com/philiplinden/bevy_repl/commit/55104ba0625ef91d54c16136e52e053d9abf7283))
+- Fancy demo ([`a328508`](https://github.com/philiplinden/bevy_repl/commit/a328508202d64ad721aca2f60fd4186e978e0c38))
+- Limitations ([`69b39fb`](https://github.com/philiplinden/bevy_repl/commit/69b39fb3109362e2fb6593032870d4884126fa1b))
 - Add known issues to readme ([`3a7dbe1`](https://github.com/philiplinden/bevy_repl/commit/3a7dbe1c7eb931a82a4b755f797e2d92aaea7bef))
-- Update readme ([`2c677ea`](https://github.com/philiplinden/bevy_repl/commit/2c677eaccfe6626643f34878005a44c9e3c387ed))
 
 ### 🐛 Bug Fixes
 
+- Disable the changelog for now ([`ca1d368`](https://github.com/philiplinden/bevy_repl/commit/ca1d36876c9188de896cfc04990fd0ad7d3f6bf8))
 - Clean up examples ([`3f6f234`](https://github.com/philiplinden/bevy_repl/commit/3f6f23478cb7fbd01e5b454cc2b9fa93857ff8d5))
 - Bad plugin setup ([`a1ebbe2`](https://github.com/philiplinden/bevy_repl/commit/a1ebbe262f5e09933b2085c6acf93c0ff20bbb93))
 - Close and quit were misconfigured ([`df104b1`](https://github.com/philiplinden/bevy_repl/commit/df104b1c2d681092473b18b247078bd3cd033c64))
 - Remove broken cmds that need world access ([`19aca25`](https://github.com/philiplinden/bevy_repl/commit/19aca254c1bdd550ea37cc8e835d5ae61730bad3))
 
 ### 🧪 Experimental
 
+- Disable changelog on main for now ([`9b02990`](https://github.com/philiplinden/bevy_repl/commit/9b02990de3259c45000b042907dcee764eb7ad8f))
+- Demo ([`a1ff6b3`](https://github.com/philiplinden/bevy_repl/commit/a1ff6b35814d12e86fea38dd553c1ff1e7a432c0))
+- Custom log layer ([`bd50098`](https://github.com/philiplinden/bevy_repl/commit/bd5009857148a6e4d3016c2539a1213aef5e0776))
+- Pretty renderer is working ([`3cd37cd`](https://github.com/philiplinden/bevy_repl/commit/3cd37cd56beeb075ec2ef06ffba426b960b3c3b1))
+- Repl println macro ([`a7bb78f`](https://github.com/philiplinden/bevy_repl/commit/a7bb78fe151ce3e30f634d93e67bb122611e465b))
+- Lots of examples and ergonomic renderer settings ([`7e3cbee`](https://github.com/philiplinden/bevy_repl/commit/7e3cbee95dc8c65a2238c4f4056c618dd125e835))
+- Custom renderer ([`ca17531`](https://github.com/philiplinden/bevy_repl/commit/ca17531f035b85ef7ff265ad74815acee74b532d))
 - Even more examples ([`e70cf98`](https://github.com/philiplinden/bevy_repl/commit/e70cf9878b71bdbe277cfddfa1c6b983c0b28bf5))
 - Overhaul ([`d0bbea2`](https://github.com/philiplinden/bevy_repl/commit/d0bbea2136678e53368615042bd024a6e4b8e075))
 - Works with windowed apps too! ([`955262b`](https://github.com/philiplinden/bevy_repl/commit/955262b2e3b1df9d111bc8fc3851bc3f19fb2c06))
@@ -37,7 +50,7 @@ Notable changes to this project will be documented in this file.
 - Add rustyline, write out design docs ([`fd4ea0f`](https://github.com/philiplinden/bevy_repl/commit/fd4ea0f9ed8be49b0333468f540dbebf32a5fa49))
 
 
-## New Contributors ❤️
+### New Contributors ❤️
 
-* @philiplinden made their first contribution in [#5](https://github.com/philiplinden/bevy_repl/pull/5)
+* @philiplinden made their first contribution
 <!-- generated by git-cliff -->

Cargo.toml

@@ -3,7 +3,7 @@ members = [".", "bevy_repl_derive"]
 
 [package]
 name = "bevy_repl"
-version = "0.4.0"
+version = "0.4.1"
 edition = "2024"
 description = "Add a REPL to headless Bevy applications"
 license = "MIT"
@@ -15,7 +15,7 @@ categories = ["game-development", "development-tools"]
 bevy = { version = "0.16.1", default-features = false, features = ["bevy_log", "trace"]}
 bevy_ratatui = { version = "0.9.2", features = ["crossterm"] }
 ratatui = "0.29.0"
-clap = { version = "4.5.45" }
+clap = { version = "4.5.46" }
 shell-words = "1.1"
 bevy_repl_derive = { version = "0.1.0", path = "./bevy_repl_derive", optional = true }
 ctrlc = "3"
@@ -34,11 +34,10 @@ default = [
 ]
 dev = ["bevy/dynamic_linking"]
 derive = ["bevy_repl_derive", "clap/derive"]
-stdout = []
-default_commands = ["quit"]
+default_commands = ["quit", "help"]
 quit = []
-clear = []
 help = []
+clear = []
 
 [[example]]
 name = "default"