---
# System prepended metadata

title: Review on Tauri doc

---

# Review on Tauri doc
Small review on the doc as :
- beginner with Tauri
- little knowledge about web dev

## Overall 
- I think it would be nice to have an example project on which all the different
  sections of the guide build on
  - Similar to the `Quick Start` section but applied to the whole guide
  - Similar to the `Setup Example` section but applied to the whole guide
 

## Quick Start 

### HTML, CSS and Javascript
- Typo in the section title with extra comma
  - `HTML, CSS, and Javascript` -> `HTML, CSS and Javascript`
- _The main function is the entry point and the first function that gets invoked when your program runs._
  - Explanation on the main function is minimal and could have additional
  information on `tauri::Builder`
  - or a link to the API

## Development 

### Updating dependencies

- `cargo outdated` 
  - not availaible out of the box, it should be specified
  - you can install it with `cargo install --locked cargo-outdated`
  - or go to the github at [https://github.com/kbknapp/cargo-outdated](https://github.com/kbknapp/cargo-outdated)

## Testing 

### Mocking Tauri APIs

- Code blocks are in Typescript which is not specified (thought it was Javascript since I've never used Typescript)
  - Where should I put such code blocks? In the root? Which name should I give to the file
- for consistency shall we put the semicolon for every line?
```
import { beforeAll, expect, test } from "vitest";
import { randomFillSync } from "crypto";

import { mockIPC } from "@tauri-apps/api/mocks"  <--- no semicolon
import { invoke } from "@tauri-apps/api/tauri";
```

### WebDriver Testing 

#### Example Application
- The page order is wrong in this section
  - we have:   _Selenium -> Setup Example -> WebdriverIO_
  - should be: _Setup Example -> WebdriverIO -> Selenium_

##### Setup Example
- inline code/command in explanations is a bit messy
  > We want to create a new binary Cargo project to house this example application. We can easily do this from the command line with cargo new hello-tauri-webdriver --bin, which will scaffold a minimal binary Cargo project for us.

  Render better as 

  > We want to create a new binary Cargo project to house this example application. 
  > We can easily scaffold a minimal binary Cargo project for us:
  > ```
  > cargo new hello-tauri-webdriver --bin
  > ```
- Same for `mkdir dist`
- Same for `curl ...`
- Same for `cargo run --release`
- Broken links for _WebdriverIO_ and _Selenium_
  - last sentence of the page 
  > We should now be ready to start testing this application with some WebDriver frameworks. This guide will go over both WebdriverIO and Selenium in that order.

##### WebdriverIO
- Inline command shall be put in a code block paragraph:
  `mkdir -p webdriver/webdriverio`

##### Selenium
- Inline command shall be put in a code block paragraph:
  `mkdir -p webdriver/selenium`

## Building 

### Linux Bundle
- AppImage: no instructions on how to build an AppIMage are given

### Reducing App Size 
- `cargo-bloat` should link to the github project 
  - https://github.com/RazrFalcon/cargo-bloat
- `rollup-plugin-visualize` should link to the github project
  - https://github.com/btd/rollup-plugin-visualizer