Documentation pre-review

[itowlson]

Creating this thread to jot down things I notice as I read the Spin docs.

[itowlson]

Consider a non-animated logo. It's mildly distracting for me, and may be more so for others.

[radu-matei]

Introduction page on the sidebar should not redirect to /index.

[radu-matei]

Sidebar should scroll independently of the main content.

[itowlson]

In prose, entry point should be two words.

[radu-matei]

Current page should be highlighted on the sidebar.

[itowlson]

How early in the docs should we mention "what it works with today"?

[itowlson]

For the quick start, there should be some information about prerequisites. E.g. "If you want to build the example applications yourself, see the Rust language guide for what you'll need."

[itowlson]

Quickstart: "focusing first on spin.toml". Consider a brief explanation of what spin.toml is because the plain filename is a bit out of the blue. E.g. "We'll start by looking at the application definition, which is in the spin.toml file."

[itowlson]

(Longer term - probably too late for 0.1) We might want to consider spin instead of spin_sdk as the crate name for the Rust Spin SDK.

[radu-matei]

(Longer term - probably too late for 0.1) We might want to consider spin instead of spin_sdk as the crate name for the Rust Spin SDK.

"spin" as a Rust crate is already taken — https://crates.io/crates/spin
Which is why I considered spin_sdk as the public crate.

[radu-matei]

The Rust language guide should mention the need to add the wasm32-wasi target.

[itowlson]

The quickstart also mentions building the sample component, so would be good to link to that from there.

[itowlson]

I would really like to see some "if something went wrong..." pointers - not necessarily breaking the flow, but just linking off in case people get lost.

[itowlson]

Configuration: "Spin applications are comprised of general information" - didn't quite know what to make of this.

[itowlson]

The app level fields in the config reference are in a different order to in the sample, which is not a problem but requires more attention to follow along.