rustwasm bookshelf #41
Merged
Conversation
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
This PR is aimed at making the this repository, and the `rustwasm.github.io` domain, the one stop shop for all documentation for Rust and WebAssembly. Currently we have a number of sources of documentation: * https://rustwasm.github.io/book - a tutorial and guide to Rust and WebAssembly * https://rustwasm.github.io/wasm-bindgen - a tutorial and guide specific to `wasm-bindgen` * https://rustwasm.github.io/wasm-pack - a tutorial and guide specific to `wasm-pack` * https://rustwasm.github.io/ - the Rust and WebAssembly blog This commit reorganizes all of these properties to instead be deployed in this repository in one location, hopefully making it easier to discover more of them and also cross-link between them. The setup here is somewhat similar to the Rust documentation itself, comprising of a number of books. When this site is built it will clone the book, wasm-bindgen, and wasm-pack repositories. The latter two will be reset to their most recent tag, matching the most recently published version on crates.io. All books are then compiled with `mdbook` and placed into the output here. The current set is then laid out as follows: * https://rustwasm.github.io/ - landing page, button to install wasm-pack, links everywhere else * https://rustwasm.github.io/blog.html - new home for the blog * https://rustwasm.github.io/docs.html - dispatch point for documentation I'm hoping that we can centralize here by using https://rustwasm.github.io if anyone wants an entry point or an easy-click installer and using `/docs.html` as the main location for documentation. Once this lands I'd like to update the deployments of the book, wasm-bindgen, and wasm-pack. All those books will gain a banner saying they're a "nightly preview" with links to the officially published versions. This means that visiting https://rustwasm.github.io/book will have a banner saying you should go to https://rustwasm.github.io/docs/book instead basically. The landing page at https://rustwasm.github.io/wasm-pack will probably stay for now (and the installer page will definitely stay), but we likely won't link to it much any more. Finally for a deployment strategy I hope to turn this into a daily cron job for this repository. That means we'll redeploy everything at least once a day, picking up any changes naturally. If we want to manually trigger a redeploy, however, we can simply reexecute the previous build on Travis.
fitzgen
approved these changes
Mar 5, 2019
There was a problem hiding this comment.
This is so so so great -- thank you @DebugSteven!!
Apologies for the late review, I guess it slipped through my inbox :-|
|
Will merge as soon as the inline suggestions are addressed :) |
+1000
What you've written in the original comment sounds great to me. The only nitpick I have is that I'd use the full "interoperate" instead of "interop" :-p |
Co-Authored-By: DebugSteven <[email protected]>
Co-Authored-By: DebugSteven <[email protected]>
Co-Authored-By: DebugSteven <[email protected]>
|
Thank you for the review on this! |
|
As a follow up I've sent a number of PRs to indicate that the gh-pages documentation we're primarily using today is for unpublished versions and the official versions are now in this repository's published documentation: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fleshes out the
docs.mdfile to provide somecontext about what the Rust and WebAssembly resources are
and what the reader might want to know before jumping into
these books. This PR is a continuation of @alexcrichton's PR
to merge the documentation for Rust and WebAssembly to one
location.
The
docs.mdformat is inspired by "The Rust Bookshelf".Once this bookshelf is merged, it might be nice to send the
docs team a PR to add a link to the Rust and WebAssembly
Bookshelf under the Specialize Rust section so that more
people can find this information in the general docs too!
I'd be happy to send that PR if that's something that would
be useful. I'd would appreciate feedback on what the
Rust and WebAssembly section should say. The Embedded
Working Group is under the Specialize Rust section
currently, if you'd like to look at an example.
Tentatively, I think this would work well as a description
to link to the Rust and WebAssembly Working Group and
the bookshelf: