Merge branch 'main' into docs/prereqs-rust

Author: mkatychev

.github/workflows/mdbook.yml

@@ -24,40 +24,58 @@ concurrency:
   group: "pages"
   cancel-in-progress: false
 
+env:
+  MDBOOK_VERSION: 0.4.21
+  MDBOOK_ALERTS_VERSION: 0.6.7
+  MDBOOK_LINKCHECK_VERSION: 0.7.7
+  PUBLISH_DOMAIN: component-model.bytecodealliance.org
+  ARTIFACT_PATH: ./component-model/book/html
+
 jobs:
-  # Build job
   build:
     runs-on: ubuntu-latest
-    env:
-      MDBOOK_VERSION: 0.4.21
-      ALERTS_VERSION: 0.6.7
-      PUBLISH_DOMAIN: component-model.bytecodealliance.org
     steps:
       - uses: actions/checkout@v3
       - name: Install mdBook
         run: |
           curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
           rustup update
-          cargo install --version ${MDBOOK_VERSION} mdbook
-          cargo install --version ${ALERTS_VERSION} mdbook-alerts
-      - name: Setup Pages
-        id: pages
-        uses: actions/configure-pages@v3
+          cargo install --version ${{ env.MDBOOK_VERSION }} mdbook
+          cargo install --version ${{ env.MDBOOK_ALERTS_VERSION }} mdbook-alerts
+          cargo install --version ${{ env.MDBOOK_LINKCHECK_VERSION }} mdbook-linkcheck
+
       - name: Build with mdBook
         run: mdbook build component-model
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.13'
+
+      # Ensure the build generated properly
+      - name: Ensure build outputs are present
+        shell: bash
+        run: |
+          if [[ ! -f "${{ env.ARTIFACT_PATH }}/index.html" ]]; then
+            echo "[error] index.html @ [${{ env.ARTIFACT_PATH }}] is missing. Build or path misconfigured";
+            exit 1;
+          fi
+
       - name: Generate sitemap
+        shell: bash
         run: |
-          cd component-model
-          python3 ../scripts/generate_sitemap.py --domain "component-model.bytecodealliance.org" --higher-priority "design" --output-path book/sitemap.xml
-          cd ..
+          cd ${{ env.ARTIFACT_PATH }}
+          python3 ../../../scripts/generate_sitemap.py --domain "component-model.bytecodealliance.org" --higher-priority "design" --output-path sitemap.xml
+          cd ../../../
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./component-model/book
+          path: ${{ env.ARTIFACT_PATH }}
 
   # Deployment job
   deploy:

component-model/src/language-support/c.md

@@ -216,3 +216,6 @@ or any other host.
 
 See the [Rust Tooling guide](../language-support/rust.md#running-a-component-from-rust-applications) for instructions on how to run this component from
 the Rust `example-host` (replacing the path to `add.wasm` with your `add-component` above).
+
+[!NOTE]: #
+[!WARNING]: #

component-model/src/language-support/csharp.md

@@ -152,6 +152,7 @@ This kind of error normally indicates that the host in question does not contain
 
 [host]: https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/example-host
 [add-to-linker]: https://docs.wasmtime.dev/api/wasmtime_wasi/fn.add_to_linker_sync.html
+[example-host]: https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/example-host
 
 ## Building a component that exports an interface
 
@@ -325,3 +326,6 @@ wasmtime run ./dist/main.wasm
 Check out the [componentize-dotnet docs][componentize-dotnet-docs] for more configurations options.
 
 [componentize-dotnet-docs]: https://github.com/bytecodealliance/componentize-dotnet
+
+[!NOTE]: #
+[!WARNING]: #

component-model/src/language-support/go.md

@@ -321,3 +321,6 @@ cargo run --release -- 1 2 /path/to/add.wasm
 ```
 
 [example-host]: https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/example-host
+
+[!NOTE]: #
+[!WARNING]: #

component-model/src/language-support/javascript.md

@@ -548,3 +548,7 @@ reverseAndUppercase('!dlroW olleH') = HELLO WORLD!
 
 [wac]: https://github.com/bytecodealliance/wac
 [jco-examples-string-reverse-upper]: https://github.com/bytecodealliance/jco/tree/main/examples/components/string-reverse-upper
+
+[!TIP]: #
+[!NOTE]: #
+[!WARNING]: #

component-model/src/language-support/python.md

@@ -154,3 +154,5 @@ $ python3 host.py
 [add-wasm]: https://github.com/bytecodealliance/component-docs/blob/main/component-model/examples/example-host/add.wasm
 
 [adder-wit]: https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/tutorial/wit/adder/world.wit
+
+[!NOTE]: #

scripts/generate_sitemap.py

@@ -5,7 +5,7 @@
 
 def parse_summary():
     """Parse URLs from the SUMMARY.md file."""
-    with open("src/SUMMARY.md", "r") as file:
+    with open("../../src/SUMMARY.md", "r") as file:
         for line in file:
             if "](" in line:
                 url = line.split("](")[1].split(")")[0]