diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 7075d277b..8cfc962d8 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -84,7 +84,7 @@ This plugin allows you to very quickly install tauri in a vue-cli project. ## [tauri-vscode](https://github.com/tauri-apps/tauri-vscode) This project enhances the VS Code interface with several nice-to-have features. -# Tauri Plugins [documentation](https://tauri.studio/en/docs/usage/guides/plugin) +# Tauri Plugins [documentation](https://tauri.studio/en/docs/guides/plugin) Generally speaking, plugins are authored by third parties (even though there may be official, supported plugins). A plugin generally does 3 things: 1. It provides rust code to do "something". diff --git a/docs/.templates/cli.md b/docs/.templates/cli.md index 146588670..c52f397d3 100644 --- a/docs/.templates/cli.md +++ b/docs/.templates/cli.md @@ -101,4 +101,4 @@ This command will show the current version of Tauri. ## CLI usage -See more about the usage through this [complete guide](/docs/usage/development/integration). +See more about the usage through this [complete guide](/docs/development/integration). diff --git a/docs/api/cli.md b/docs/api/cli.md index e5a27a3b5..21d8de872 100644 --- a/docs/api/cli.md +++ b/docs/api/cli.md @@ -188,4 +188,4 @@ This command will show the current version of Tauri. ## CLI usage -See more about the usage through this [complete guide](/docs/usage/development/integration). +See more about the usage through this [complete guide](/docs/development/integration). diff --git a/docs/api/config.md b/docs/api/config.md index 3c719fcdd..bf626fe58 100644 --- a/docs/api/config.md +++ b/docs/api/config.md @@ -158,8 +158,8 @@ In addition to the JSON defined on the `tauri.conf.json` file, Tauri reads a pla { property: "longDescription", optional: true, type: "string", description: `A longer, multi-line description of the application.` }, { property: "deb", optional: true, type: "object", child: boostrapper script.` }, - { property: "files", optional: true, type: "{ [path: string]: string }", description: `The files to include on the package. See the debian guide.` }]} /> + { property: "useBootstrapper", optional: true, type: "boolean", description: `Enable the boostrapper script.` }, + { property: "files", optional: true, type: "{ [path: string]: string }", description: `The files to include on the package. See the debian guide.` }]} /> }, { property: "windows", optional: true, type: "object", child: -After that, you'll be ready to [add Tauri to your project!](/docs/usage/development/integration) +After that, you'll be ready to [add Tauri to your project!](/docs/development/integration) diff --git a/docs/getting-started/setup-linux.md b/docs/get-started/setup-linux.md similarity index 98% rename from docs/getting-started/setup-linux.md rename to docs/get-started/setup-linux.md index d6f3b5152..6ed835ed9 100644 --- a/docs/getting-started/setup-linux.md +++ b/docs/get-started/setup-linux.md @@ -146,4 +146,4 @@ You can download some examples to try with `sudo apt-get install x11-apps`. xeye ## Continue -Now that you have set up the Linux-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/usage/development/integration). +Now that you have set up the Linux-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/development/integration). diff --git a/docs/getting-started/setup-macos.md b/docs/get-started/setup-macos.md similarity index 96% rename from docs/getting-started/setup-macos.md rename to docs/get-started/setup-macos.md index b012675f7..c1ec30729 100644 --- a/docs/getting-started/setup-macos.md +++ b/docs/get-started/setup-macos.md @@ -76,4 +76,4 @@ You may need to restart your terminal if the command does not work. ## Continue -Now that you have set up the macOS-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/usage/development/integration). +Now that you have set up the macOS-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/development/integration). diff --git a/docs/getting-started/setup-windows.md b/docs/get-started/setup-windows.md similarity index 97% rename from docs/getting-started/setup-windows.md rename to docs/get-started/setup-windows.md index b26f57c55..e47ba182e 100644 --- a/docs/getting-started/setup-windows.md +++ b/docs/get-started/setup-windows.md @@ -72,4 +72,4 @@ If you have problems of any kind after following these instructions, we recommen ## Continue -Now that you have set up the Windows-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/usage/development/integration). +Now that you have set up the Windows-specific dependencies for Tauri, learn how to [add Tauri to your project](/docs/development/integration). diff --git a/docs/usage/guides/bundler/anti-bloat.md b/docs/guides/bundler/anti-bloat.md similarity index 98% rename from docs/usage/guides/bundler/anti-bloat.md rename to docs/guides/bundler/anti-bloat.md index 7f50073f2..067fa9118 100644 --- a/docs/usage/guides/bundler/anti-bloat.md +++ b/docs/guides/bundler/anti-bloat.md @@ -59,7 +59,7 @@ See your local `strip` manpage for more information and flags that can be used t ### Allowlist config -You can also reduce the application size with the `allowlist` config, and only enabling what you need. Sometimes this is useful with Tauri's [Bridge-Pattern](/docs/usage/patterns/bridge) or others, depending on needs. +You can also reduce the application size with the `allowlist` config, and only enabling what you need. Sometimes this is useful with Tauri's [Bridge-Pattern](/docs/guides/patterns/bridge) or others, depending on needs. For example in `tauri.conf.json` file: diff --git a/docs/usage/guides/bundler/debian.md b/docs/guides/bundler/debian.md similarity index 100% rename from docs/usage/guides/bundler/debian.md rename to docs/guides/bundler/debian.md diff --git a/docs/usage/guides/bundler/introduction.md b/docs/guides/bundler/introduction.md similarity index 100% rename from docs/usage/guides/bundler/introduction.md rename to docs/guides/bundler/introduction.md diff --git a/docs/usage/guides/bundler/sidecar.md b/docs/guides/bundler/sidecar.md similarity index 100% rename from docs/usage/guides/bundler/sidecar.md rename to docs/guides/bundler/sidecar.md diff --git a/docs/usage/guides/bundler/sign-osx.md b/docs/guides/bundler/sign-osx.md similarity index 100% rename from docs/usage/guides/bundler/sign-osx.md rename to docs/guides/bundler/sign-osx.md diff --git a/docs/usage/guides/cli.md b/docs/guides/cli.md similarity index 100% rename from docs/usage/guides/cli.md rename to docs/guides/cli.md diff --git a/docs/usage/guides/command.md b/docs/guides/command.md similarity index 100% rename from docs/usage/guides/command.md rename to docs/guides/command.md diff --git a/docs/usage/contributor-guide.md b/docs/guides/contributor-guide.md similarity index 100% rename from docs/usage/contributor-guide.md rename to docs/guides/contributor-guide.md diff --git a/docs/usage/guides/events.md b/docs/guides/events.md similarity index 100% rename from docs/usage/guides/events.md rename to docs/guides/events.md diff --git a/docs/usage/guides/visual/icons.md b/docs/guides/icons.md similarity index 100% rename from docs/usage/guides/visual/icons.md rename to docs/guides/icons.md diff --git a/docs/usage/guides/visual/menu.md b/docs/guides/menu.md similarity index 100% rename from docs/usage/guides/visual/menu.md rename to docs/guides/menu.md diff --git a/docs/usage/guides/migration.md b/docs/guides/migration.md similarity index 100% rename from docs/usage/guides/migration.md rename to docs/guides/migration.md diff --git a/docs/usage/guides/utils/multiwindow.md b/docs/guides/multiwindow.md similarity index 100% rename from docs/usage/guides/utils/multiwindow.md rename to docs/guides/multiwindow.md diff --git a/docs/usage/patterns/about-patterns.md b/docs/guides/patterns/about-patterns.md similarity index 100% rename from docs/usage/patterns/about-patterns.md rename to docs/guides/patterns/about-patterns.md diff --git a/docs/usage/patterns/bridge.md b/docs/guides/patterns/bridge.md similarity index 100% rename from docs/usage/patterns/bridge.md rename to docs/guides/patterns/bridge.md diff --git a/docs/usage/patterns/cloudbridge.md b/docs/guides/patterns/cloudbridge.md similarity index 100% rename from docs/usage/patterns/cloudbridge.md rename to docs/guides/patterns/cloudbridge.md diff --git a/docs/usage/patterns/cloudish.md b/docs/guides/patterns/cloudish.md similarity index 100% rename from docs/usage/patterns/cloudish.md rename to docs/guides/patterns/cloudish.md diff --git a/docs/usage/patterns/glui.md b/docs/guides/patterns/glui.md similarity index 100% rename from docs/usage/patterns/glui.md rename to docs/guides/patterns/glui.md diff --git a/docs/usage/patterns/hermit.md b/docs/guides/patterns/hermit.md similarity index 100% rename from docs/usage/patterns/hermit.md rename to docs/guides/patterns/hermit.md diff --git a/docs/usage/patterns/lockdown.md b/docs/guides/patterns/lockdown.md similarity index 89% rename from docs/usage/patterns/lockdown.md rename to docs/guides/patterns/lockdown.md index 75dfbd4e5..957187432 100644 --- a/docs/usage/patterns/lockdown.md +++ b/docs/guides/patterns/lockdown.md @@ -46,7 +46,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl' ## Description -The Lockdown recipe is a minimal usage of the [Bridge pattern](/docs/usage/patterns/bridge), which only allows interaction between Rust and the Window via expiring JS Promise Closures that are injected into the Window by Rust and nulled as part of the callback. +The Lockdown recipe is a minimal usage of the [Bridge pattern](/docs/guides/patterns/bridge), which only allows interaction between Rust and the Window via expiring JS Promise Closures that are injected into the Window by Rust and nulled as part of the callback. ## Diagram diff --git a/docs/usage/patterns/multiwin.md b/docs/guides/patterns/multiwin.md similarity index 100% rename from docs/usage/patterns/multiwin.md rename to docs/guides/patterns/multiwin.md diff --git a/docs/usage/guides/plugin.md b/docs/guides/plugin.md similarity index 100% rename from docs/usage/guides/plugin.md rename to docs/guides/plugin.md diff --git a/docs/usage/guides/visual/splashscreen.md b/docs/guides/splashscreen.md similarity index 100% rename from docs/usage/guides/visual/splashscreen.md rename to docs/guides/splashscreen.md diff --git a/docs/usage/guides/visual/system-tray.md b/docs/guides/system-tray.md similarity index 100% rename from docs/usage/guides/visual/system-tray.md rename to docs/guides/system-tray.md diff --git a/docs/usage/guides/updater.md b/docs/guides/updater.md similarity index 100% rename from docs/usage/guides/updater.md rename to docs/guides/updater.md diff --git a/docs/usage/guides/webdriver/ci.md b/docs/guides/webdriver/ci.md similarity index 100% rename from docs/usage/guides/webdriver/ci.md rename to docs/guides/webdriver/ci.md diff --git a/docs/usage/guides/webdriver/example/selenium.md b/docs/guides/webdriver/example/selenium.md similarity index 100% rename from docs/usage/guides/webdriver/example/selenium.md rename to docs/guides/webdriver/example/selenium.md diff --git a/docs/usage/guides/webdriver/example/setup.md b/docs/guides/webdriver/example/setup.md similarity index 100% rename from docs/usage/guides/webdriver/example/setup.md rename to docs/guides/webdriver/example/setup.md diff --git a/docs/usage/guides/webdriver/example/webdriverio.md b/docs/guides/webdriver/example/webdriverio.md similarity index 100% rename from docs/usage/guides/webdriver/example/webdriverio.md rename to docs/guides/webdriver/example/webdriverio.md diff --git a/docs/usage/guides/webdriver/introduction.md b/docs/guides/webdriver/introduction.md similarity index 100% rename from docs/usage/guides/webdriver/introduction.md rename to docs/guides/webdriver/introduction.md diff --git a/docs/usage/guides/visual/window-customization.md b/docs/guides/window-customization.md similarity index 100% rename from docs/usage/guides/visual/window-customization.md rename to docs/guides/window-customization.md diff --git a/docs/sidebar.json b/docs/sidebar.json index 8cb2d4266..52fe3ce7f 100644 --- a/docs/sidebar.json +++ b/docs/sidebar.json @@ -1,101 +1,86 @@ [ { - "label": "Getting started", + "label": "Get started", "type": "category", "items": [ - "getting-started/intro", - "getting-started/setup-linux", - "getting-started/setup-macos", - "getting-started/setup-windows" + "get-started/intro", + "get-started/setup-linux", + "get-started/setup-macos", + "get-started/setup-windows" ] }, { - "label": "Usage", + "label": "Development", + "type": "category", + "items": [ + "development/intro", + "development/integration", + "development/development", + "development/debugging", + "development/ci-cd", + "development/cross-platform", + "development/publishing", + "development/updating" + ] + }, + { + "label": "Guides", "type": "category", "items": [ - "usage/intro", - { - "label": "Development", - "type": "category", - "items": [ - "usage/development/integration", - "usage/development/development", - "usage/development/debugging", - "usage/development/publishing", - "usage/development/updating" - ] - }, { "label": "Patterns", "type": "category", "items": [ - "usage/patterns/about-patterns", - "usage/patterns/hermit", - "usage/patterns/bridge", - "usage/patterns/cloudish", - "usage/patterns/cloudbridge", - "usage/patterns/lockdown", - "usage/patterns/multiwin", - "usage/patterns/glui" + "guides/patterns/about-patterns", + "guides/patterns/hermit", + "guides/patterns/bridge", + "guides/patterns/cloudish", + "guides/patterns/cloudbridge", + "guides/patterns/lockdown", + "guides/patterns/multiwin", + "guides/patterns/glui" ] }, { - "label": "Guides", + "label": "Bundler", "type": "category", "items": [ - "usage/guides/migration", - { - "label": "Bundler", - "type": "category", - "items": [ - "usage/guides/bundler/introduction", - "usage/guides/bundler/anti-bloat", - "usage/guides/bundler/sidecar", - "usage/guides/bundler/debian", - "usage/guides/bundler/sign-osx" - ] - }, - "usage/guides/cli", - "usage/guides/command", - "usage/guides/events", - "usage/guides/plugin", - "usage/guides/updater", - { - "label": "Visual", - "type": "category", - "items": [ - "usage/guides/visual/icons", - "usage/guides/visual/splashscreen", - "usage/guides/visual/window-customization", - "usage/guides/visual/menu", - "usage/guides/visual/system-tray" - ] - }, - { - "label": "WebDriver Testing", - "type": "category", - "items": [ - "usage/guides/webdriver/introduction", - { - "label": "Example Application", - "type": "category", - "items": [ - "usage/guides/webdriver/example/setup", - "usage/guides/webdriver/example/webdriverio", - "usage/guides/webdriver/example/selenium" - ] - }, - "usage/guides/webdriver/ci" - ] - } + "guides/bundler/introduction", + "guides/bundler/anti-bloat", + "guides/bundler/sidecar", + "guides/bundler/debian", + "guides/bundler/sign-osx" ] }, + "guides/cli", + "guides/command", + "guides/events", + "guides/plugin", + "guides/updater", + "guides/icons", + "guides/splashscreen", + "guides/window-customization", + "guides/menu", + "guides/system-tray", { - "label": "CI/CD", + "label": "WebDriver Testing", "type": "category", - "items": ["usage/ci-cd/workflow", "usage/ci-cd/cross-platform"] + "items": [ + "guides/webdriver/introduction", + { + "label": "Example Application", + "type": "category", + "items": [ + "guides/webdriver/example/setup", + "guides/webdriver/example/webdriverio", + "guides/webdriver/example/selenium" + ] + }, + "guides/webdriver/ci" + ] }, - "usage/contributor-guide" + "guides/migration", + "guides/contributor-guide" ] }, { diff --git a/tooling/webdriver/README.md b/tooling/webdriver/README.md index 4f23bead7..4021d2669 100644 --- a/tooling/webdriver/README.md +++ b/tooling/webdriver/README.md @@ -23,7 +23,7 @@ will be used that wraps around [wry]._ ## Trying it out -Check out the documentation at https://tauri.studio/en/docs/usage/guides/webdriver/ci to build a small example +Check out the documentation at https://tauri.studio/en/docs/guides/webdriver/ci to build a small example application that had WebDriver tests. [WebDriver Intermediary Node]: https://www.w3.org/TR/webdriver/#dfn-intermediary-nodes