Reorder book-based documentation#8130
Merged
Merged
Conversation
On a high level, this is what this PR changed:
1. Move the CLI chapter before the API chapter.
I think this makes sense because the CLI is more high-level.
The same change was proposed in
bytecodealliance#7987.
1. Move some Rust and C examples from the "Examples" chapter into the API chapter.
1. Remove the original main C and Rust chapter introduction files.
They contained mostly outdated or duplicate information.
1. Rename the "Examples" chapter to "Further Examples".
(For lack of a better name.)
1. 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.
1. Read through the entire document and fix some outdated links and information.
1. Fix a missing subheading for Elixir (it was mentioned on the lang page, but not in the menu).
github-actions
Bot
added
the
wasmtime:docs
Member
|
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! |
alexcrichton
approved these changes
Mar 14, 2024
Member
alexcrichton
left a comment
alexcrichton
left a comment
There was a problem hiding this comment.
Thanks for this! I like the organization better here as well 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: