Update Docs (tauri-apps#449)

* chore(docs): Update Rust & TS docs

* fix index id

Co-authored-by: FabianLars <[email protected]>
Co-authored-by: FabianLars <[email protected]>

Author: tauri-bot

docs/api/js/index.md renamed to docs/api/js/README.md

@@ -2,16 +2,7 @@
 
 # @tauri-apps/api
 
-The Tauri API allows you to interface with the backend layer.
-
-This module exposes all other modules as an object where the key is the module name, and the value is the module exports.
-
-**`example`**
-```typescript
-import { app, dialog, event, fs, globalShortcut } from '@tauri-apps/api'
-```
-
-## Namespaces
+## Modules
 
 - [app](modules/app.md)
 - [cli](modules/cli.md)
@@ -21,6 +12,7 @@ import { app, dialog, event, fs, globalShortcut } from '@tauri-apps/api'
 - [fs](modules/fs.md)
 - [globalShortcut](modules/globalShortcut.md)
 - [http](modules/http.md)
+- [mocks](modules/mocks.md)
 - [notification](modules/notification.md)
 - [os](modules/os.md)
 - [path](modules/path.md)

docs/api/js/classes/http.Body.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [http](../modules/http.md) / Body
+[@tauri-apps/api](../README.md) / [http](../modules/http.md) / Body
 
 # Class: Body
 
@@ -14,7 +14,7 @@ The body object to be used on POST and PUT requests.
 
 #### Defined in
 
-[http.ts:64](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L64)
+[http.ts:64](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L64)
 
 ___
 
@@ -24,7 +24,7 @@ ___
 
 #### Defined in
 
-[http.ts:63](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L63)
+[http.ts:63](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L63)
 
 ## Methods
 
@@ -48,7 +48,7 @@ The body object ready to be used on the POST and PUT requests.
 
 #### Defined in
 
-[http.ts:119](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L119)
+[http.ts:119](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L119)
 
 ___
 
@@ -72,7 +72,7 @@ The body object ready to be used on the POST and PUT requests.
 
 #### Defined in
 
-[http.ts:79](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L79)
+[http.ts:79](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L79)
 
 ___
 
@@ -96,7 +96,7 @@ The body object ready to be used on the POST and PUT requests.
 
 #### Defined in
 
-[http.ts:97](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L97)
+[http.ts:97](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L97)
 
 ___
 
@@ -120,4 +120,4 @@ The body object ready to be used on the POST and PUT requests.
 
 #### Defined in
 
-[http.ts:108](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L108)
+[http.ts:108](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L108)

docs/api/js/classes/http.Client.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [http](../modules/http.md) / Client
+[@tauri-apps/api](../README.md) / [http](../modules/http.md) / Client
 
 # Class: Client
 
@@ -12,7 +12,7 @@
 
 #### Defined in
 
-[http.ts:189](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L189)
+[http.ts:189](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L189)
 
 ## Methods
 
@@ -43,7 +43,7 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:333](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L333)
+[http.ts:333](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L333)
 
 ___
 
@@ -59,7 +59,7 @@ Drops the client instance.
 
 #### Defined in
 
-[http.ts:200](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L200)
+[http.ts:200](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L200)
 
 ___
 
@@ -90,7 +90,7 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:261](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L261)
+[http.ts:261](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L261)
 
 ___
 
@@ -121,7 +121,7 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:318](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L318)
+[http.ts:318](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L318)
 
 ___
 
@@ -153,7 +153,7 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:277](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L277)
+[http.ts:277](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L277)
 
 ___
 
@@ -185,7 +185,7 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:298](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L298)
+[http.ts:298](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L298)
 
 ___
 
@@ -215,4 +215,4 @@ A promise resolving to the response.
 
 #### Defined in
 
-[http.ts:216](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L216)
+[http.ts:216](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L216)

docs/api/js/classes/http.Response.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [http](../modules/http.md) / Response
+[@tauri-apps/api](../README.md) / [http](../modules/http.md) / Response
 
 # Class: Response<T\>
 
@@ -22,7 +22,7 @@ The response data.
 
 #### Defined in
 
-[http.ts:175](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L175)
+[http.ts:175](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L175)
 
 ___
 
@@ -34,7 +34,7 @@ The response headers.
 
 #### Defined in
 
-[http.ts:171](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L171)
+[http.ts:171](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L171)
 
 ___
 
@@ -46,7 +46,7 @@ A boolean indicating whether the response was successful (status in the range 20
 
 #### Defined in
 
-[http.ts:169](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L169)
+[http.ts:169](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L169)
 
 ___
 
@@ -58,7 +58,7 @@ The response raw headers.
 
 #### Defined in
 
-[http.ts:173](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L173)
+[http.ts:173](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L173)
 
 ___
 
@@ -70,7 +70,7 @@ The response status code.
 
 #### Defined in
 
-[http.ts:167](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L167)
+[http.ts:167](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L167)
 
 ___
 
@@ -82,4 +82,4 @@ The request URL.
 
 #### Defined in
 
-[http.ts:165](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/http.ts#L165)
+[http.ts:165](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/http.ts#L165)

docs/api/js/classes/shell.Child.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [shell](../modules/shell.md) / Child
+[@tauri-apps/api](../README.md) / [shell](../modules/shell.md) / Child
 
 # Class: Child
 
@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[shell.ts:183](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L183)
+[shell.ts:183](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L183)
 
 ## Properties
 
@@ -30,7 +30,7 @@ The child process `pid`.
 
 #### Defined in
 
-[shell.ts:181](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L181)
+[shell.ts:181](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L181)
 
 ## Methods
 
@@ -48,7 +48,7 @@ A promise indicating the success or failure of the operation.
 
 #### Defined in
 
-[shell.ts:218](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L218)
+[shell.ts:218](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L218)
 
 ___
 
@@ -80,4 +80,4 @@ A promise indicating the success or failure of the operation.
 
 #### Defined in
 
-[shell.ts:201](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L201)
+[shell.ts:201](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L201)

docs/api/js/classes/shell.Command.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [shell](../modules/shell.md) / Command
+[@tauri-apps/api](../README.md) / [shell](../modules/shell.md) / Command
 
 # Class: Command
 
@@ -49,7 +49,7 @@ Creates a new `Command` instance.
 
 #### Defined in
 
-[shell.ts:266](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L266)
+[shell.ts:266](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L266)
 
 ## Properties
 
@@ -61,7 +61,7 @@ Event emitter for the `stderr`. Emits the `data` event.
 
 #### Defined in
 
-[shell.ts:256](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L256)
+[shell.ts:256](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L256)
 
 ___
 
@@ -73,7 +73,7 @@ Event emitter for the `stdout`. Emits the `data` event.
 
 #### Defined in
 
-[shell.ts:254](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L254)
+[shell.ts:254](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L254)
 
 ## Methods
 
@@ -100,7 +100,7 @@ A promise resolving to the child process output.
 
 #### Defined in
 
-[shell.ts:343](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L343)
+[shell.ts:343](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L343)
 
 ___
 
@@ -129,7 +129,7 @@ The `this` instance for chained calls.
 
 #### Defined in
 
-[shell.ts:173](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L173)
+[shell.ts:173](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L173)
 
 ___
 
@@ -147,7 +147,7 @@ A promise resolving to the child process handle.
 
 #### Defined in
 
-[shell.ts:306](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L306)
+[shell.ts:306](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L306)
 
 ___
 
@@ -177,4 +177,4 @@ const output = await command.execute()
 
 #### Defined in
 
-[shell.ts:291](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L291)
+[shell.ts:291](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L291)

docs/api/js/classes/shell.EventEmitter.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [shell](../modules/shell.md) / EventEmitter
+[@tauri-apps/api](../README.md) / [shell](../modules/shell.md) / EventEmitter
 
 # Class: EventEmitter<E\>
 
@@ -51,4 +51,4 @@ The `this` instance for chained calls.
 
 #### Defined in
 
-[shell.ts:173](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/shell.ts#L173)
+[shell.ts:173](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/shell.ts#L173)

docs/api/js/classes/window.LogicalPosition.md

@@ -1,4 +1,4 @@
-[@tauri-apps/api](../index.md) / [window](../modules/window.md) / LogicalPosition
+[@tauri-apps/api](../README.md) / [window](../modules/window.md) / LogicalPosition
 
 # Class: LogicalPosition
 
@@ -21,7 +21,7 @@ A position represented in logical pixels.
 
 #### Defined in
 
-[window.ts:159](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/window.ts#L159)
+[window.ts:159](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/window.ts#L159)
 
 ## Properties
 
@@ -31,7 +31,7 @@ A position represented in logical pixels.
 
 #### Defined in
 
-[window.ts:155](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/window.ts#L155)
+[window.ts:155](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/window.ts#L155)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[window.ts:156](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/window.ts#L156)
+[window.ts:156](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/window.ts#L156)
 
 ___
 
@@ -51,4 +51,4 @@ ___
 
 #### Defined in
 
-[window.ts:157](https://github.com/tauri-apps/tauri/blob/d24045e/tooling/api/src/window.ts#L157)
+[window.ts:157](https://github.com/tauri-apps/tauri/blob/e1b2d2b/tooling/api/src/window.ts#L157)