Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add WebAssembly Bookshelf to The Rust Bookshelf #58973

Closed
wants to merge 1 commit into from

Conversation

DebugSteven
Copy link
Contributor

This PR adds a section for WebAssembly to the Specialize Rust section of The Rust Bookshelf.
This is a new change for the Rust and WebAssembly team in this PR: rustwasm/rustwasm.github.io#41

@rust-highfive
Copy link
Collaborator

r? @QuietMisdreavus

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 6, 2019
@QuietMisdreavus
Copy link
Member

cc @rust-lang/docs for adding a new entry to the bookshelf

@QuietMisdreavus
Copy link
Member

QuietMisdreavus commented Mar 6, 2019

So, something that might cause a problem is that this doesn't add the wasm book to the doc distribution (EDIT: i.e. we don't build the wasm book(s) as part of x.py doc), like how the embedded book is. However, Rustlings and the Rustc Contribution Guide are also linked externally, so it may be fine? I'd like to get a second opinion from someone else on the docs team before i r+.

@steveklabnik
Copy link
Member

Didn't we do this already? I am feeling very strong deja vu.

And yes, we should be importing the actual book, not linking externally.

Rustlings isn't a book; it's an interactive thing you run with cargo.

With the rustc guide, I didn't understand it externally linked; I would have blocked that :/ @nikomatsakis ?

@QuietMisdreavus
Copy link
Member

We added the Embedded Book about a month ago in #56291 - maybe that's what you're remembering?

@steveklabnik
Copy link
Member

It was certainly wasm. Maybe it was in-person conversations and not a PR directly.

@DebugSteven
Copy link
Contributor Author

For my own understanding, why would is it preferred that bookshelf not be linked externally?
Would it make it more difficult for the wasm team to add/update docs if the bookshelf were imported?

I know it would be more effort for the team to extract the book into a submodule to import it into this bookshelf so I'm hoping to understand the motivation behind wanting to go that route.

@QuietMisdreavus
Copy link
Member

QuietMisdreavus commented Mar 7, 2019

The Bookshelf and the local files created by x.py doc are shipped with Rustup with all Rust installations as the rust-docs component. For this reason, anything we can ship alongside the bookshelf lets people view their docs offline, which has been a bit of a priority for us. Linking to online docs elsewhere kinda subverts this pattern.

It's worth noting that the Embedded WG also has several books, and only ships the "main" book in this bookshelf - all the others are kept on their own docs site. They have some prior discussion in rust-embedded/wg#257 that the Wasm WG could possibly crib from.

@DebugSteven
Copy link
Contributor Author

We discussed this in the wasm working group meeting today & we are doing some work on The Rust Wasm Book. Since we'll be going the route of importing the book here, we can open a different PR when we are ready to add it to this bookshelf. Thanks!

@DebugSteven DebugSteven closed this Mar 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants