Rust support documentation install guide [WIP]

[codingfrog27]

Second round PR

• Added reducing binary size section.
• various miscelanous styling and capitalisation feedback implemented
• Moved prerequissites into installing the toolchain
• removed link to glossary for the word "Pod"
• moved in document comments to this PR message
• filled in empty links
• added target, cross-compilation,, system image to glossary

doc considerations

Most of these will fall back to the central questions of: How much do we want to expand docs for inexperienced users vs how much do we want to keep it concise for experienced once.

• on introduction section: Could put less emphasis or different wording on cross compilation and different targets

  • and/or a specific mention BP doesnt have a Rust runtime in the Pods

• Could add the cargo new hello_world command to step 2 for any user that doesn't already have a rust project set up yet.

---

First draft off Rust installation Guide

Additions

• install guide for the BrowserPod Rust toolchain: prerequisites,
  install script, activating the toolchain, building for
  wasm32-browserpod-linux-musl, uninstall/update, and troubleshooting.
• small glossary addition
• Renamed previous binary doc page to avoid confusion

Todo

• EIther add a symlink to the llvm of rust or add llvm and clang to prerequisites in documentation
• quick local build check to adjust whitespace.
• add loading binary in pod guide (alt: extention on write files to a pod page)
• potential more advanced rust details (that I also need to first research more like: cfg values (target_arch = "wasm64"), panic=abort,
  no dynamic linking, 1 MB stack, bundled OpenSSL
• smoke test all steps both with and without added llvm-ar for removed host dependency
  - observe changed toolchain size on both too
• adjust roadmap page

[GabrielaReyna]

Hi Merlin,

Good work on this. I can see the guide is in a very draft state in terms of formatting and you focused on the technical parts, there were lots of inconsistencies with the writing and structure. This will need a second pass and a second review.

I can see that this guide includes multiple sections that, if they grow might be worth splitting into multiple guides (e.g. one for installing, one for troubleshooting). But we can keep it as one for now.

I am thinking also splitting the docs per tech supported is also a good idea (guides section for Node, guides section for Rust). We can discuss this.

Many thanks!

[cloudflare-workers-and-pages]

Deploying labs-browserpod-previews with    Cloudflare Pages

Latest commit:	da4edca
Status:	✅  Deploy successful!
Preview URL:	https://6322e69b.labs-browserpod-previews.pages.dev
Branch Preview URL:	https://rust-support-documentation.labs-browserpod-previews.pages.dev

View logs

[GabrielaReyna]

Please use lowercase for the file names, capitalizing filenames leads to broken links

[GabrielaReyna]

Hi Merlin,

I have added several comments, this includes guides structures, typos, wording etc.

Please review throughly, I advice you do a pass on your writing before requesting a PR review.