From 0c421f6e8cbbfa482611c2403a8b10fb437ea127 Mon Sep 17 00:00:00 2001 From: Altug Sahin Date: Mon, 5 Sep 2022 14:58:19 -0400 Subject: [PATCH] Document formatting and typo fixes (#495) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * minor formatting * Internationalization: move guide to en folder and preserve its history. (#494) * chore: move guide to en folder * docs: add english as language * merged conf resolved * chore: remove outdated docs * chore: use taffy dimension directly * Add PT-BR translations (#456) * Translate final.md, hello_world.md, README.md, ROADMAP.md and SUMMARY.md * Translatation complete * Internationalization: move guide to en folder and preserve its history. (#494) * Clean files and build mdBook with localization feature * Rebase, remove leftovers and check book builds for every language: ✅ Co-authored-by: Jon Kelley * Remove argument from `use_hook` closure (#496) Also; update docs for said function * chore: prevent reference from being uploaded Co-authored-by: Altug Sahin Co-authored-by: Jon Kelley Co-authored-by: Breno Rocha <66398400+amindWalker@users.noreply.github.com> Co-authored-by: Reinis Mazeiks Co-authored-by: = --- README.md | 2 +- docs/guide/src/{ => en}/lib.rs | 0 notes/README.md | 6 +++--- 3 files changed, 4 insertions(+), 4 deletions(-) rename docs/guide/src/{ => en}/lib.rs (100%) diff --git a/README.md b/README.md index 2aee239c6..f50889eab 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ If you know React, then you already know Dioxus. ## Example Projects: | File Navigator (Desktop) | WiFi scanner (Desktop) | TodoMVC (All platforms) | E-commerce w/ Tailwind (SSR/LiveView) | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [![File Explorer](https://github.com/DioxusLabs/example-projects/raw/master/file-explorer/image.png)](https://github.com/DioxusLabs/example-projects/blob/master/file-explorer) | [![Wifi Scanner Demo](https://github.com/DioxusLabs/example-projects/raw/master/wifi-scanner/demo_small.png)](https://github.com/DioxusLabs/example-projects/blob/master/wifi-scanner) | [![TodoMVC example](https://github.com/DioxusLabs/example-projects/raw/master/todomvc/example.png)](https://github.com/DioxusLabs/example-projects/blob/master/todomvc) | [![E-commerce Example](https://github.com/DioxusLabs/example-projects/raw/master/ecommerce-site/demo.png)](https://github.com/DioxusLabs/example-projects/blob/master/ecommerce-site) | See the [awesome-dioxus](https://github.com/DioxusLabs/awesome-dioxus) page for a curated list of content in the Dioxus Ecosystem. diff --git a/docs/guide/src/lib.rs b/docs/guide/src/en/lib.rs similarity index 100% rename from docs/guide/src/lib.rs rename to docs/guide/src/en/lib.rs diff --git a/notes/README.md b/notes/README.md index 1556afff4..21d6d7329 100644 --- a/notes/README.md +++ b/notes/README.md @@ -29,14 +29,14 @@ Dioxus is heavily inspired by React, supporting many of the same concepts: If you know React, then you know Dioxus. Dioxus is *substantially* more performant than many of the other Rust UI libraries (Yew/Percy) and is *significantly* more performant -than React - roughly competitve with InfernoJS. +than React - roughly competitive with InfernoJS. Remember: Dioxus is a library for declaring interactive user interfaces - it is not a dedicated renderer. Most 1st party renderers for Dioxus currently only support web technologies. ## Brief Overview All Dioxus apps are built by composing functions that take in a `Scope` which is generic over some `Properties` and return an `Element`. -A `Scope` holds relevant state data for the the currently-rendered component. +A `Scope` holds relevant state data for the currently-rendered component. To launch an app, we use the `launch` method for the specific renderer we want to use. In the launch function, we pass the app's `Component`. @@ -322,4 +322,4 @@ Alternatives to Dioxus include: - MoonZoom/Seed: opinionated frameworks based on the Elm model (message, update) - no hooks We've put a lot of work into making Dioxus ergonomic and *familiar*. -Our target audience is TypeSrcipt developers looking to switch to Rust for the web - so we need to be comparabale to React. +Our target audience is TypeScript developers looking to switch to Rust for the web - so we need to be comparable to React.