Merge branch 'main' into tr-translation-of-day-1-afternoon

Author: Enes1313

.cargo/config.toml

@@ -0,0 +1,9 @@
+[alias]
+# We use this alias for task automation in the project.
+# See README in xtask directory.
+xtask = "run --package xtask --"
+
+[env]
+# To provide an anchor to the root of the workspace when working with paths.
+# See https://github.com/rust-lang/cargo/issues/3946#issuecomment-973132993
+CARGO_WORKSPACE_DIR = { value = "", relative = true }

.github/CODEOWNERS

@@ -11,11 +11,26 @@ po/it.po @detro @nicomazz
 po/ja.po @keiichiw @chikoski @kantasv @HidenoriKobayashi
 po/ko.po @jiyongp @jooyunghan @namhyung
 po/pl.po @jkotur @dyeroshenko
-po/pt-BR.po @rastringer @hugojacob @henrif75 @joaovicmendes @jcvicelli @azevedoalice
+po/pt-BR.po @rastringer @hugojacob @henrif75 @joaovicmendes @azevedoalice
 po/ro.po @AlexandraImbrisca @razvanm
 po/ru.po @istolga @baltuky @zvonden @dyeroshenko
 po/tr.po @alerque
 po/uk.po @dyeroshenko
 po/vi.po @daivinhtran @qu-ngx
 po/zh-CN.po @wnghl @anlunx @kongy @noahdragon @superwhd @emmali01 @candysonya @AgainstEntropy
-po/zh-TW.po @edong @hueich @kuanhungchen @victorhsieh @mingyc @johnathan79717
+po/zh-TW.po @edong @hueich @kuanhungchen @victorhsieh @mingyc
+
+# Dependency changes (mostly dependabot PRs)
+Cargo.toml @djmitche @mgeisler @qwandor
+Cargo.lock @djmitche @mgeisler @qwandor
+src/bare-metal/alloc-example/Cargo.toml @djmitche @mgeisler @qwandor
+src/bare-metal/alloc-example/Cargo.lock @djmitche @mgeisler @qwandor
+src/bare-metal/aps/examples/Cargo.toml @djmitche @mgeisler @qwandor
+src/bare-metal/aps/examples/Cargo.lock @djmitche @mgeisler @qwandor
+src/bare-metal/microcontrollers/examples/Cargo.toml @djmitche @mgeisler @qwandor
+src/bare-metal/microcontrollers/examples/Cargo.lock @djmitche @mgeisler @qwandor
+src/exercises/bare-metal/compass/Cargo.toml @djmitche @mgeisler @qwandor
+src/exercises/bare-metal/compass/Cargo.lock @djmitche @mgeisler @qwandor
+src/exercises/bare-metal/rtc/Cargo.toml @djmitche @mgeisler @qwandor
+src/exercises/bare-metal/rtc/Cargo.lock @djmitche @mgeisler @qwandor
+.github/workflows @djmitche @mgeisler @qwandor

.github/dependabot.yml

@@ -7,10 +7,6 @@ updates:
     directory: /
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -24,10 +20,6 @@ updates:
     directory: /src/bare-metal/alloc-example/
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -41,10 +33,6 @@ updates:
     directory: /src/bare-metal/aps/examples/
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -58,10 +46,6 @@ updates:
     directory: /src/bare-metal/microcontrollers/examples/
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -75,10 +59,6 @@ updates:
     directory: /src/exercises/bare-metal/compass/
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -92,10 +72,6 @@ updates:
     directory: /src/exercises/bare-metal/rtc/
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor
     commit-message:
       prefix: cargo
     groups:
@@ -109,7 +85,3 @@ updates:
     directory: /
     schedule:
       interval: monthly
-    reviewers:
-      - djmitche
-      - mgeisler
-      - qwandor

.github/workflows/build.sh

@@ -9,6 +9,8 @@ set -Eeuo pipefail
 #
 # The src/ and third_party/ directories are left in a dirty state so
 # you can run `mdbook test` and other commands afterwards.
+#
+# See also TRANSLATIONS.md.
 
 book_lang=${1:?"Usage: $0 <book-lang> <dest-dir>"}
 dest_dir=${2:?"Usage: $0 <book-lang> <dest-dir>"}
@@ -23,7 +25,7 @@ else
     # Back-date the sources to POT-Creation-Date. The content lives in two
     # directories:
     rm -r src/ third_party/
-    git restore --source "$(git rev-list -n 1 --before "$pot_creation_date" @)" src/ third_party/
+    git restore --source "$(git rev-list -n 1 --before "$pot_creation_date" @)" src/ third_party/ book.toml
     # Set language and adjust site URL. Clear the redirects since they are
     # in sync with the source files, not the translation.
     export MDBOOK_BOOK__LANGUAGE=$book_lang

.github/workflows/build.yml

@@ -28,7 +28,7 @@ jobs:
           rustup component add rustfmt
 
       - name: Check formatting
-        uses: dprint/check@v2.2
+        uses: dprint/check@v2.3
 
   typos:
     runs-on: ubuntu-latest
@@ -37,7 +37,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Check for typos
-        uses: crate-ci/typos@v1.28.1
+        uses: crate-ci/typos@v1.34.0
         with:
           config: ./.github/typos.toml
 
@@ -161,10 +161,6 @@ jobs:
           MDBOOK_OUTPUT='{"xgettext": {"pot-file": "messages.pot"}}' mdbook build -d po
           msgfmt -o /dev/null --statistics po/messages.pot
 
-      - name: Install mdbook-linkcheck
-        if: contains(fromJSON(env.LINK_CHECKED_LANGUAGES), matrix.language)
-        run: cargo install mdbook-linkcheck --locked --version 0.7.7
-
       - name: Build ${{ matrix.language }} translation
         run: |
           .github/workflows/build.sh ${{ matrix.language }} book/comprehensive-rust-${{ matrix.language }}
@@ -182,14 +178,21 @@ jobs:
         run: mdbook test
 
       - name: Setup Node
+        if: matrix.language == 'en'
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
+          cache: "npm"
+          cache-dependency-path: "tests/package-lock.json"
       - name: Install test framework
+        if: matrix.language == 'en'
         run: npm install
         working-directory: ./tests
       - name: Test Javascript
-        run: npm test
+        if: matrix.language == 'en'
+        run: |
+          ./src/slides/create-slide.list.sh
+          npm test
         env:
           TEST_BOOK_DIR: ../book/comprehensive-rust-${{ matrix.language }}/html
         working-directory: ./tests
@@ -203,6 +206,9 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Update Rust
+        run: rustup update
+
       - name: Setup Rust cache
         uses: ./.github/workflows/setup-rust-cache
 

.github/workflows/install-mdbook/action.yml

@@ -5,37 +5,14 @@ description: Install mdbook with the dependencies we need.
 runs:
   using: composite
   steps:
-    # The --locked flag is important for reproducible builds. It also
-    # avoids breakage due to skews between mdbook and mdbook-svgbob.
     - name: Install mdbook
-      run: cargo install mdbook --locked --version 0.4.37
+      run: cargo xtask install-tools
       shell: bash
 
-    - name: Install mdbook-svgbob
-      run: cargo install mdbook-svgbob --locked --version 0.2.1
-      shell: bash
-
-    - name: Install mdbook-pandoc and related dependencies
+    - name: Install dependencies for mdbook-pandoc
       run: |
-        cargo install mdbook-pandoc --locked --version 0.7.0
         sudo apt-get update
-        sudo apt-get install -y texlive texlive-luatex texlive-lang-cjk librsvg2-bin fonts-noto
-        curl -LsSf https://github.com/jgm/pandoc/releases/download/3.2.1/pandoc-3.2.1-linux-amd64.tar.gz | tar zxf -
-        echo "$PWD/pandoc-3.2.1/bin" >> $GITHUB_PATH
-      shell: bash
-
-    - name: Install mdbook-i18n-helpers
-      run: cargo install mdbook-i18n-helpers --locked --version 0.3.3
-      shell: bash
-
-    - name: Install i18n-report
-      run: cargo install i18n-report --locked --version 0.2.0
-      shell: bash
-
-    - name: Install mdbook-exerciser
-      run: cargo install --path mdbook-exerciser --locked
-      shell: bash
-
-    - name: Install mdbook-course
-      run: cargo install --path mdbook-course --locked
+        sudo apt-get install -y texlive texlive-luatex texlive-lang-cjk texlive-lang-arabic librsvg2-bin fonts-noto
+        curl -LsSf https://github.com/jgm/pandoc/releases/download/3.7.0.1/pandoc-3.7.0.1-linux-amd64.tar.gz | tar zxf -
+        echo "$PWD/pandoc-3.7.0.1/bin" >> $GITHUB_PATH
       shell: bash

.github/workflows/publish.yml

@@ -1,5 +1,7 @@
 name: Publish
 
+# See also TRANSLATIONS.md.
+
 on:
   push:
     branches:
@@ -33,6 +35,9 @@ jobs:
         with:
           fetch-depth: 0 # We need the full history for build.sh below.
 
+      - name: Update Rust
+        run: rustup update
+
       - name: Setup Rust cache
         uses: ./.github/workflows/setup-rust-cache
 

.gitignore

@@ -31,3 +31,6 @@ crowdin.yml
 
 # Python virtualenv (for mdbook-slide-evaluator local installation)
 .venv/
+
+# tests/ framework artifacts
+tests/src/slide/slides/slides.list.ts

CONTRIBUTING.md

@@ -8,6 +8,27 @@ the [instructions in the README].
 
 [instructions in the README]: README.md#building
 
+## Writing Exercises
+
+Each segment ends with an exercise. Exercises are typically structured as an
+`exercise.rs` containing the problem and solution. This is referenced from
+`exercise.md` and `solution.md`, using `{{#include exercise.rs:anchor_name}}` to
+match ANCHOR comments in the `exercise.rs` file. Each segment also has a
+`Cargo.toml` file containing a `[[bin]]` or `[lib]` section referring to
+`exercise.rs`, and that Cargo package is referenced from the workspace the root
+`Cargo.toml`. The result is that `exercise.rs` is built and tested by
+`cargo test`.
+
+For segments on day 1, exercises should use `fn main() { .. }` and `dbg!` or
+`println!`, with students visually verifying the correct output. On subsequent
+days, prefer tests and omit `fn main() { .. }`. However, where tests would be
+difficult and visual verification is more natural (such as in the Logger
+exercise), using `fn main { .. }` is OK.
+
+Especially for exercises without tests, consider including tests in
+`exercise.rs` that do not appear in either `exercise.md` or `solution.md`, as
+these can ensure the solution is correct.
+
 ## Testing
 
 We test the course material in several ways:
@@ -38,10 +59,12 @@ Install `dprint` using their
 [installation instructions](https://dprint.dev/install/) and install `rustfmt`
 via `rustup`.
 
+Install [pandoc 3.7.0.1](https://github.com/jgm/pandoc/releases/tag/3.7.0.1).
+
 On Debian, you can install the other tools using:
 
 ```sh
-sudo apt install yapf3 gettext
+sudo apt install yapf3 gettext texlive texlive-luatex texlive-lang-cjk texlive-lang-arabic librsvg2-bin fonts-noto
 ```
 
 ### MacOS