Stream: git-wasmtime

Topic: wasmtime / PR #11757 Reorganize example documentation

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:07):

alexcrichton opened PR #11757 from alexcrichton:organize-docs to bytecodealliance:main:

This commit reorganizes example documentation in our online documentation. The main changes here are:

• Chapter-per-language is now removed in favor of tabs-in-a-page for avoiding having the book be so large. Tabs are made with [mdbook-langtabs].
• Language-specific pages are all consolidated into a single page.
• Language-specific documentation now only mentions where to find docs instead of trying to document an intro for each language here.
• "Further examples" was folded into the main API section, meaning we just have one chapter of a lot of examples.

The main goal is to make the book less overwhelming from an example perspective and ideally make it a bit easier to discover things. The langtabs plugin is nice but not perfect, e.g. it doesn't support #-anchors nor remembers which language you were looking at. Overall though I feel this is still better than before.

[mdbook-langtabs]: https://github.com/nx10/mdbook-langtabs

<!--
Please make sure you include the following information:

• If this work has been discussed elsewhere, please include a link to that
  conversation. If it was discussed in an issue, just mention "issue #...".

• Explain why this change is needed. If the details are in an issue already,
  this can be brief.

Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.html

Please ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:07):

alexcrichton has marked PR #11757 as ready for review.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:07):

alexcrichton requested wasmtime-default-reviewers for a review on PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:07):

alexcrichton requested cfallin for a review on PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:14):

pchickey submitted PR review.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:33):

fitzgen submitted PR review.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:33):

fitzgen created PR review comment:

in the same repository as Wasmtime itself. Installation of `wasmtime` can be

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:33):

fitzgen created PR review comment:

bytecodealliance GitHub organization but are still not tested/developed in-sync

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:40):

alexcrichton updated PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 18:40):

alexcrichton has enabled auto merge for PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 19:21):

alexcrichton updated PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 19:22):

alexcrichton commented on PR #11757:

For that CI failure I've opted to remove mdbook test from CI. I think examples/tests are much better served by doc tests and examples nowadays and otherwise there's no way to get mdbook test and mdbook-langtabs to agree that the Rust bits included here shouldn't be tested.

Wasmtime GitHub notifications bot (Sep 29 2025 at 19:22):

alexcrichton has enabled auto merge for PR #11757.

Wasmtime GitHub notifications bot (Sep 29 2025 at 19:57):

alexcrichton merged PR #11757.

Last updated: Dec 06 2025 at 07:03 UTC