Răsfoiți Sursa

docs: clean up setup

Jonathan Kelley 3 ani în urmă
părinte
comite
9839f52355
2 a modificat fișierele cu 10 adăugiri și 21 ștergeri
  1. 0 15
      docs/blog/01-release.md
  2. 10 6
      docs/src/setup.md

+ 0 - 15
docs/blog/01-release.md

@@ -1,15 +0,0 @@
-
-- Rust's smart pointers make use_state extremely easy and fun to work with.
-- Multiple flavors (raw, html, rsx) of templating to pick-and-choose for the type of component.
-- Extensible DSL through traits and impls plus support for WebComponents.
-- Simple-to-implement trait for new reconcilers.
-- Fast retained-mode server-side-renderer that works with buffered writers, files, and strings.
-- Compile-time correct inline CSS as well as global styling.
-- Integrated "signal" system allows for near-instant updates by skipping the diff algorithm entirely.
-- Built-in cooperative scheduler (IE React's fiber mechanism).
-- Built-in asynchronous scheduler for coroutines and tasks within components.
-- Built-in suspense scheduler for Rust's futures.
-- Extremely fast diffing algorithm for the most complex of apps.
-- Runs natively on mobile and on desktop with no need for a 3rd party JS engine.
-- Drastically fewer runtime errors and crashes with first-class error handling.
-- Extremely powerful iterator and optional chaining integration for fast and robust apps.

+ 10 - 6
docs/src/setup.md

@@ -2,7 +2,7 @@
 
 Dioxus aims to provide a fast, friendly, and portable toolkit for building user interfaces with Rust.
 
-This guide assumes you'll be building a SPA (single page application) for the web. The process for building desktop apps, server-rendered apps, static sites, and mobile apps, is more-or-less the same. You can check out the [Platform Specific Guides](../platforms/00-index.md) for more information on setting up Dioxus for any of the various targets you are building for.
+This Getting Setup guide assumes you'll be building a small desktop application. The process for building web-apps, desktop apps, server-rendered apps, static sites, and mobile apps, is more-or-less the same. You can check out the [Platform Specific Guides](../platforms/00-index.md) for more information on setting up Dioxus for any of the various targets you are building for.
 
 # Setting up Dioxus
 
@@ -10,10 +10,12 @@ Dioxus requires a few main things to get up and running:
 
 - The [Rust compiler](https://www.rust-lang.org) and associated build tooling
 
-- An editor of your choice, with the [Rust-Analyzer LSP plugin](https://rust-analyzer.github.io)
+- An editor of your choice, ideally configured with the [Rust-Analyzer LSP plugin](https://rust-analyzer.github.io)
 
 Dioxus integrates very well with the Rust-Analyzer IDE plugin which will provide appropriate syntax highlighting, code navigation, folding, and more.
 
+### Dioxus-CLI for dev server, bundling, etc.
+
 We also recommend installing the Dioxus CLI. The Dioxus CLI automates building and packaging for various targets and integrates with simulators, development servers, and app deployment. It'll be our one-stop-shop for anything related to building and sharing our Dioxus Apps. To install the CLI, you'll need cargo (should be automatically installed with Rust):
 
 ```
@@ -28,15 +30,17 @@ $ cargo install --force dioxus-cli
 
 If your version of the CLI is out of date, it'll remind you to update whenever a new version is uploaded to Rust's package manager [crates.io](https://crates.io). We use a dedicated 1st-party CLI to save you from having to run potentially untrusted code every time you add a crate to your project - as is standard in the NPM ecosystem. You can vet the source of the Dioxus-CLI yourself at its [GitHub repo](https://github.com/jkelleyrtp/dioxus/tree/master/packages/cli).
 
+### Suggested extensions
+
 If you want to keep your traditional `npm install XXX` workflow for adding packages, you might want to install `cargo-edit` and a few other fun `cargo` extensions:
 
 - [cargo edit](https://github.com/killercup/cargo-edit) for adding dependencies from the CLI
 - [cargo-expand](https://github.com/dtolnay/cargo-expand) for expanding macro calls
-- `cargo tree` - an integrated cargo command that lets you inspect your dependency tree
+- [cargo tree](https://doc.rust-lang.org/cargo/commands/cargo-tree.html) - an integrated cargo command that lets you inspect your dependency tree
 
-That's it! We won't need to touch NPM/WebPack/Babel/Parcel, etc.
+That's it! We won't need to touch NPM/WebPack/Babel/Parcel, etc. However, you _can_ configure your app to use WebPack with [traditional WASM-pack tooling](https://rustwasm.github.io/wasm-pack/book/tutorials/hybrid-applications-with-webpack/using-your-library.html).
 
-# Important tools
+## Rust Knowledge
 
 With Rust, things like benchmarking, testing, and documentation are included in the language. We strongly recommend going through the official Rust book _completely_. However, our hope is that a Dioxus app can serve as a great first project. With Dioxus you'll learn about:
 
@@ -45,7 +49,7 @@ With Rust, things like benchmarking, testing, and documentation are included in
 - Closures
 - Macros
 
-We've put a lot of care into making Dioxus syntax familiar and easy to understand, so you won't need knowledge on async, lifetimes, and smart pointers until you really start building complex Dioxus apps.
+We've put a lot of care into making Dioxus syntax familiar and easy to understand, so you won't need deep knowledge on async, lifetimes, or smart pointers until you really start building complex Dioxus apps.
 
 We strongly encourage exploring the guides for more information on how to work with the integrated tooling: