Wasmtime GitHub notifications bot (Mar 14 2024 at 07:31): Wasmtime GitHub notifications bot (Mar 14 2024 at 07:31):rikhuijzer opened PR #8130 from rikhuijzer:rh/reorder-docs to bytecodealliance:main:
This PR suggests to reorder the book-based documentation. The main change is moving the CLI chapter before the API (embedding) chapter like was proposed in #7987 by @alexcrichton. The rest is mostly cleaning up of duplicate or outdated information.
With these changes, this PR fixes some confusion that I had with the current layout. Currently, it's not so clear how the Subsection "2.3 Embedding in Rust" relates to Chapter "3. Using WebAssembly from your language" with Subsection "3.1 Rust". With these changes, these two examples are merged and now all fall under Chapter "2. Using the Wasmtime API".
More specifically, this is what this PR changed:
- Move the CLI chapter before the API chapter.
- Move some Rust and C examples from the "Examples" chapter into the API chapter.
- Remove the original main C and Rust chapter introduction files. They contained mostly outdated or duplicate information.
- Rename the "Examples" chapter to "Further Examples". (For lack of a better name.)
- Rename "Embedding" to "API" at some places since API is a more generally known term. The term "embedding" is also slightly more confusing, I think, because the term nowadays also used a lot in LLM-related communication.
- Fix some outdated links and documentation by reading through the entire book.
- Fix a missing subheading for Elixir (it was mentioned on the lang page, but not in the menu).
Wasmtime GitHub notifications bot (Mar 14 2024 at 07:31):rikhuijzer requested cfallin for a review on PR #8130.
Wasmtime GitHub notifications bot (Mar 14 2024 at 07:31):rikhuijzer requested wasmtime-default-reviewers for a review on PR #8130.
Wasmtime GitHub notifications bot (Mar 14 2024 at 07:32):rikhuijzer edited PR #8130:
This PR suggests to reorder the book-based documentation. The main change is moving the CLI chapter before the API (embedding) chapter like was proposed in #7987 by @alexcrichton. The rest is mostly cleaning up of duplicate or outdated information.
With these changes, this PR fixes some confusion that I had with the current layout. Currently, it's not so clear how the Subsection "2.3 Embedding in Rust" relates to Chapter "3. Using WebAssembly from your language" with Subsection "3.1 Rust". With these changes, these two examples are merged and now all fall under Chapter "2. Using the Wasmtime API".
More specifically, this is what this PR changed:
- Move the CLI chapter before the API chapter (like proposed in #7987).
- Move some Rust and C examples from the "Examples" chapter into the API chapter.
- Remove the original main C and Rust chapter introduction files. They contained mostly outdated or duplicate information.
- Rename the "Examples" chapter to "Further Examples". (For lack of a better name.)
- Rename "Embedding" to "API" at some places since API is a more generally known term. The term "embedding" is also slightly more confusing, I think, because the term nowadays also used a lot in LLM-related communication.
- Fix some outdated links and documentation by reading through the entire book.
- Fix a missing subheading for Elixir (it was mentioned on the lang page, but not in the menu).
Wasmtime GitHub notifications bot (Mar 14 2024 at 15:08):cfallin requested alexcrichton for a review on PR #8130.
Wasmtime GitHub notifications bot (Mar 14 2024 at 15:09):cfallin commented on PR #8130:
Reassigning review to @alexcrichton as it's not totally clear to me how this should relate with the still-pending #7987. Thanks @rikhuijzer for the careful thought around all of these changes though; they do seem like reasonable cleanups to me!
Wasmtime GitHub notifications bot (Mar 14 2024 at 17:41):alexcrichton submitted PR review:
Thanks for this! I like the organization better here as well :+1:
Wasmtime GitHub notifications bot (Mar 14 2024 at 18:23):alexcrichton merged PR #8130.
Last updated: Oct 23 2024 at 20:03 UTC