Initial Tutorial info (#29)

* Initial Tutorial info

* Roughly finishing the rest of the tutorial

* Add serde to Cargo

* Update book with mermaid

* Use Nix in GitHub CI, codespell, rustfmt, clippy

* Update workflows

* Use dev flakes for alsa and udev

* Switch to DeterminateSystems actions

* Add pkgs-config to native build inputs

* Fix workflows, start typestate chapter

* Revisions and shortening

* Small tweaks

* Condense tutorial

* Remove install for mermaid,admonish and perform in CI

.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+skip = .git,target,node_modules,dist,*.yaml,*.lock,./book/book,*.min.js
+ignore-words-list = implementor,implementors,ser,crate
+count =
+quiet-level = 3

.github/workflows/book.yml

@@ -0,0 +1,29 @@
+name: publish-tutorial
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  tutorial:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: DeterminateSystems/flake-checker-action@main
+
+      - name: Build Tutorial
+        run: |
+             nix develop --command mdbook-admonish install book
+             nix develop --command mdbook-mermaid install book
+             nix develop --command mdbook build book
+
+      - uses: JamesIves/github-pages-deploy-action@v4.3.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: ./book/book
+          clean: true

.github/workflows/ci.yml

@@ -14,12 +14,11 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Setup
-        uses: ./.github/workflows/setup
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: DeterminateSystems/flake-checker-action@main
 
-      - name: Argus tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
+      - name: Argus Test
+        run: nix develop --command ci-check

.github/workflows/release.yml

@@ -10,37 +10,31 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions-rs/install@v0.1
-        with:
-          crate: cargo-workspaces
-          version: latest
-          use-tool-cache: true
-      - name: Setup
-        uses: ./.github/workflows/setup
-      - run: cargo ws publish skip --no-remove-dev-deps --from-git --yes --token ${{ secrets.CRATES_IO }}
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: DeterminateSystems/flake-checker-action@main
+      - run: nix develop --command \
+          cargo ws publish skip --no-remove-dev-deps --from-git --yes --token ${{ secrets.CRATES_IO }}
 
   publish-ide:
     runs-on: ubuntu-latest
     needs: publish-crates
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
 
-      - name: Setup
-        uses: ./.github/workflows/setup
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: DeterminateSystems/flake-checker-action@main
 
-      - name: Publish to Open VSX Registry
-        uses: HaaLeo/publish-vscode-extension@v1
-        id: publishToOpenVSX
-        with:
-          pat: ${{ secrets.OVSX_MRKT }}
-          packagePath: "./ide/packages/extension"
+      - name: Build TS bindings
+        run: nix develop --command cargo make init-bindings
 
-      - name: Publish to Visual Studio Marketplace
-        uses: HaaLeo/publish-vscode-extension@v1
-        with:
-          pat: ${{ secrets.VSCODE_MRKT }}
-          registryUrl: https://marketplace.visualstudio.com
-          packagePath: "./ide/packages/extension"
+      - name: Depot Setup
+        run: nix develop --command depot setup
+
+      - name: Publish Extension
+        run: |
+          cd ide/packages/extension
+          nix develop --command vsce package
+          nix develop --command vsce publish -p ${{ secrets.VSCODE_MRKT }} --packagePath argus-*.vsix
+          nix develop --command pnpx ovsx publish argus-*.vsix -p ${{ secrets.OVSX_MRKT }}

.gitignore

@@ -17,7 +17,6 @@ gha-creds-*.json
 /org/meeting*
 /org/*.png
 /org/media/
-sample-book/
 
 # Rust things
 target/

book/.gitignore

@@ -1 +1,4 @@
 book
+mdbook-admonish.css
+mermaid-init.js
+mermaid.min.js

book/book.toml

@@ -6,4 +6,20 @@ src = "src"
 title = "Argus: a trait debugger for Rust"
 
 [output.html]
+default-theme = "light"
+
 curly-quotes = true
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
+additional-css = ["./mdbook-admonish.css"]
+
+[preprocessor]
+
+[preprocessor.image-size]
+command = "mdbook-image-size"
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
+[preprocessor.admonish]
+command = "mdbook-admonish"
+assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`

book/src/SUMMARY.md

@@ -2,14 +2,9 @@
 
 [Introduction](README.md)
 
-- [Debugging trait errors](debug-media.md)
+<!-- - [Whirlwind Tour](whirlwind.md) -->
 
-- [How to think about Argus]()
+- [Trait Debugging 101](trait-debugging-101.md)
 
-- [Debug a Bevy game]()
+- [Trait Methods and Typestate](typestate.md)
 
-- [Debug an Axum server]()
-
-- [Debug async Rust]()
-
-- [Debug stack overflows]()