Browse Source

docs: add more doc

Jonathan Kelley 3 years ago
parent
commit
d5b05d640b

+ 9 - 11
docs/guide/src/SUMMARY.md

@@ -6,33 +6,31 @@
 - [Describing the UI](elements/index.md)
 - [Describing the UI](elements/index.md)
   - [Intro to Elements](elements/vnodes.md)
   - [Intro to Elements](elements/vnodes.md)
   - [Intro to Components](elements/components.md)
   - [Intro to Components](elements/components.md)
+  - [The Props Macro](elements/propsmacro.md)
   - [Reusing, Importing, and Exporting Components](elements/exporting_components.md)
   - [Reusing, Importing, and Exporting Components](elements/exporting_components.md)
   - [Passing children and attributes](elements/component_children.md)
   - [Passing children and attributes](elements/component_children.md)
   - [Conditional Rendering](elements/conditional_rendering.md)
   - [Conditional Rendering](elements/conditional_rendering.md)
   - [Lists](elements/lists.md)
   - [Lists](elements/lists.md)
 - [Adding Interactivity](interactivity/index.md)
 - [Adding Interactivity](interactivity/index.md)
   - [Hooks and Internal State](interactivity/hooks.md)
   - [Hooks and Internal State](interactivity/hooks.md)
-
-  <!-- - [Event handlers](interactivity/event_handlers.md)
+  - [Event handlers](interactivity/event_handlers.md)
   - [User Input and Controlled Components](interactivity/user_input.md)
   - [User Input and Controlled Components](interactivity/user_input.md)
-  - [Lifecycle, updates, and effects](interactivity/lifecycles.md) -->
-<!-- 
+  - [Lifecycle, updates, and effects](interactivity/lifecycles.md)
 - [Managing State](state/index.md)
 - [Managing State](state/index.md)
   - [Local State](state/localstate.md) 
   - [Local State](state/localstate.md) 
   - [Lifting State](state/liftingstate.md) 
   - [Lifting State](state/liftingstate.md) 
   - [Global State](state/sharedstate.md)
   - [Global State](state/sharedstate.md)
-  - [Error handling](state/errorhandling.md) -->
-
-<!-- - [Working with Async](async/index.md)
-  - [Tasks](async/asynctasks.md) -->
-
-<!-- - [Putting it all together: Dog Search Engine](tutorial/index.md)
+  - [Error handling](state/errorhandling.md)
+- [Working with Async](async/index.md)
+  - [Tasks](async/asynctasks.md)
+  - [Fetching](async/fetching.md)
+- [Putting it all together: Dog Search Engine](tutorial/index.md)
   - [New app](tutorial/new_app.md)
   - [New app](tutorial/new_app.md)
   - [Structuring our app](tutorial/structure.md)
   - [Structuring our app](tutorial/structure.md)
   - [Defining State](tutorial/state.md)
   - [Defining State](tutorial/state.md)
   - [Defining Components](tutorial/components.md)
   - [Defining Components](tutorial/components.md)
   - [Styling](tutorial/styling.md)
   - [Styling](tutorial/styling.md)
-  - [Bundling](tutorial/publishing.md) -->
+  - [Bundling](tutorial/publishing.md)
 - [Next Steps and Advanced Topics](final.md)
 - [Next Steps and Advanced Topics](final.md)
 
 
 
 

+ 1 - 0
docs/guide/src/async/fetching.md

@@ -0,0 +1 @@
+# Fetching

+ 1 - 0
docs/guide/src/elements/propsmacro.md

@@ -0,0 +1 @@
+# The Props Macro

+ 17 - 0
docs/guide/src/setup.md

@@ -30,6 +30,23 @@ Once installed, make sure to  install wasm32-unknown-unknown as a target if you'
 rustup target add wasm32-unknown-unknown
 rustup target add wasm32-unknown-unknown
 ```
 ```
 
 
+### Platform-Specific Dependencies
+
+If you are running a modern, mainstream operating system, you should need no additional setup to build WebView-based Desktop apps. However, if you are running an older version of Windows or a flavor of linux with no default web rendering engine, you might need to install some additional dependencies.
+
+For windows users: download the [bootstrapper for Webview2 from Microsoft](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)
+
+For linux users, we need the development libraries for libgtk.
+
+````
+sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libappindicator3-dev
+```
+
+When distributing onto older Windows platforms or less-mainstream 
+
+
+
+
 ### Dioxus-CLI for dev server, bundling, etc.
 ### 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. To install the CLI, you'll need cargo (should be automatically installed with Rust):
 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. To install the CLI, you'll need cargo (should be automatically installed with Rust):

+ 1 - 1
docs/guide/src/tutorial/index.md

@@ -17,7 +17,7 @@ The app is running on the web [here]() but is also available:
 - a mobile app
 - a mobile app
 - and as an API endpoint here
 - and as an API endpoint here
 
 
-![Weather App Image](static/weather_app.png)
+![Weather App Image](/static/weather_app.png)
 
 
 
 
 Let's get started! Head on to the next chapter where we create our app.
 Let's get started! Head on to the next chapter where we create our app.

+ 10 - 5
docs/guide/src/tutorial/new_app.md

@@ -1,10 +1,10 @@
 # New app
 # New app
 
 
-To get started, let's create a new Rust project for our app. 
+To get started, let's create a new Rust project for our Dog Search Engine.
 
 
 ```shell
 ```shell
-$ cargo new --bin weatherapp
-$ cd weatherapp
+$ cargo new --bin doggo
+$ cd doggo
 ```
 ```
 
 
 Make sure our project builds by default
 Make sure our project builds by default
@@ -12,9 +12,9 @@ Make sure our project builds by default
 ```shell
 ```shell
 $ cargo run
 $ cargo run
 
 
-   Compiling weatherapp v0.1.0
+   Compiling doggo v0.1.0
     Finished dev [unoptimized + debuginfo] target(s) in 0.41s
     Finished dev [unoptimized + debuginfo] target(s) in 0.41s
-     Running `target/debug/weatherapp`
+     Running `target/debug/doggo`
 Hello, world!
 Hello, world!
 ```
 ```
 
 
@@ -53,3 +53,8 @@ fn app(cx: Scope) -> Element {
 
 
 
 
 ## Making sure things run
 ## Making sure things run
+
+
+
+
+