Parcourir la source

Restructure docs (#3180)

Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
Kasper il y a 3 ans
Parent
commit
4f9c9e6307
50 fichiers modifiés avec 76 ajouts et 98 suppressions
  1. 1 1
      ARCHITECTURE.md
  2. 1 1
      docs/.templates/cli.md
  3. 1 1
      docs/api/cli.md
  4. 2 2
      docs/api/config.md
  5. 2 2
      docs/development/ci-cd.md
  6. 0 0
      docs/development/cross-platform.md
  7. 0 0
      docs/development/debugging.md
  8. 0 0
      docs/development/development.md
  9. 1 1
      docs/development/integration.md
  10. 7 14
      docs/development/intro.md
  11. 0 0
      docs/development/publishing.md
  12. 0 0
      docs/development/signing-macos.md
  13. 0 0
      docs/development/updating.md
  14. 1 1
      docs/get-started/intro.md
  15. 1 1
      docs/get-started/setup-linux.md
  16. 1 1
      docs/get-started/setup-macos.md
  17. 1 1
      docs/get-started/setup-windows.md
  18. 1 1
      docs/guides/bundler/anti-bloat.md
  19. 0 0
      docs/guides/bundler/debian.md
  20. 0 0
      docs/guides/bundler/introduction.md
  21. 0 0
      docs/guides/bundler/sidecar.md
  22. 0 0
      docs/guides/bundler/sign-osx.md
  23. 0 0
      docs/guides/cli.md
  24. 0 0
      docs/guides/command.md
  25. 0 0
      docs/guides/contributor-guide.md
  26. 0 0
      docs/guides/events.md
  27. 0 0
      docs/guides/icons.md
  28. 0 0
      docs/guides/menu.md
  29. 0 0
      docs/guides/migration.md
  30. 0 0
      docs/guides/multiwindow.md
  31. 0 0
      docs/guides/patterns/about-patterns.md
  32. 0 0
      docs/guides/patterns/bridge.md
  33. 0 0
      docs/guides/patterns/cloudbridge.md
  34. 0 0
      docs/guides/patterns/cloudish.md
  35. 0 0
      docs/guides/patterns/glui.md
  36. 0 0
      docs/guides/patterns/hermit.md
  37. 1 1
      docs/guides/patterns/lockdown.md
  38. 0 0
      docs/guides/patterns/multiwin.md
  39. 0 0
      docs/guides/plugin.md
  40. 0 0
      docs/guides/splashscreen.md
  41. 0 0
      docs/guides/system-tray.md
  42. 0 0
      docs/guides/updater.md
  43. 0 0
      docs/guides/webdriver/ci.md
  44. 0 0
      docs/guides/webdriver/example/selenium.md
  45. 0 0
      docs/guides/webdriver/example/setup.md
  46. 0 0
      docs/guides/webdriver/example/webdriverio.md
  47. 0 0
      docs/guides/webdriver/introduction.md
  48. 0 0
      docs/guides/window-customization.md
  49. 54 69
      docs/sidebar.json
  50. 1 1
      tooling/webdriver/README.md

+ 1 - 1
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".

+ 1 - 1
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).

+ 1 - 1
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).

+ 2 - 2
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: <Properties anchorRoot="tauri.bundle.deb" rows={[
         { property: "depends", optional: true, type: "string[]", description: `The list of deb dependencies your application relies on.` },
-        { property: "useBootstrapper", optional: true, type: "boolean", description: `Enable the <a href="/en/docs/usage/guides/bundler/debian#bootstrapper">boostrapper script</a>.` },
-        { property: "files", optional: true, type: "{ [path: string]: string }", description: `The files to include on the package. See <a href="/en/docs/usage/guides/bundler/debian#custom-files">the debian guide</a>.` }]} />
+        { property: "useBootstrapper", optional: true, type: "boolean", description: `Enable the <a href="/en/docs/guides/bundler/debian#bootstrapper">boostrapper script</a>.` },
+        { property: "files", optional: true, type: "{ [path: string]: string }", description: `The files to include on the package. See <a href="/en/docs/guides/bundler/debian#custom-files">the debian guide</a>.` }]} />
       },
       { property: "windows", optional: true, type: "object", child: <Properties anchorRoot="tauri.bundle.windows" rows={[
         { property: "digestAlgorithm", optional: true, type: "string", description: `Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.` },

+ 2 - 2
docs/usage/ci-cd/workflow.md → docs/development/ci-cd.md

@@ -1,6 +1,6 @@
 ---
-id: workflow
-title: Workflow
+id: ci-cd
+title: CI/CD
 ---
 
 ## Continuous Integration

+ 0 - 0
docs/usage/ci-cd/cross-platform.md → docs/development/cross-platform.md


+ 0 - 0
docs/usage/development/debugging.md → docs/development/debugging.md


+ 0 - 0
docs/usage/development/development.md → docs/development/development.md


+ 1 - 1
docs/usage/development/integration.md → docs/development/integration.md

@@ -158,7 +158,7 @@ This information can be very helpful when triaging problems.
 ### Patterns
 
 We've also defined prebuilt configurations called "Patterns". They may help you to customize Tauri to fit your needs.
-[See more about patterns](/docs/usage/patterns/about-patterns).
+[See more about patterns](/docs/guides/patterns/about-patterns).
 
 ## Vue CLI Plugin Tauri
 

+ 7 - 14
docs/usage/intro.md → docs/development/intro.md

@@ -10,17 +10,10 @@ Here you will find guides and techniques to start a new project or add to your o
 
 ## Tauri Development Workflow
 
-- [Integrate with Tauri](/docs/usage/development/integration)
-- [Development Cycle](/docs/usage/development/development)
-- [Debugging](/docs/usage/development/debugging)
-- [App Publishing](/docs/usage/development/publishing)
-- [Updating Packages](/docs/usage/development/updating)
-
-## Guides
-
-- [How to embed custom binaries](/docs/usage/guides/bundler/sidecar)
-- [How to customize app icons](/docs/usage/guides/visual/icons)
-
-## Others
-- [Understanding Tauri Patterns](/docs/usage/patterns/about-patterns)
-- 
+- [Integrate With Tauri](/docs/development/integration)
+- [Development Cycle](/docs/development/development)
+- [Debugging](/docs/development/debugging)
+- [CI/CD](/docs/development/ci-cd)
+- [Cross-Platform Compilation](/docs/development/cross-platform)
+- [App Publishing](/docs/development/publishing)
+- [Updating Packages](/docs/development/updating)

+ 0 - 0
docs/usage/development/publishing.md → docs/development/publishing.md


+ 0 - 0
docs/usage/ci-cd/signing-macos.md → docs/development/signing-macos.md


+ 0 - 0
docs/usage/development/updating.md → docs/development/updating.md


+ 1 - 1
docs/getting-started/intro.md → docs/get-started/intro.md

@@ -44,4 +44,4 @@ Follow the platform-specific guides to get started:
     windows: { title: 'Windows Setup', link: '/docs/getting-started/setup-windows'}
 }} />
 
-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)

+ 1 - 1
docs/getting-started/setup-linux.md → 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).

+ 1 - 1
docs/getting-started/setup-macos.md → 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).

+ 1 - 1
docs/getting-started/setup-windows.md → 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).

+ 1 - 1
docs/usage/guides/bundler/anti-bloat.md → 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:
 

+ 0 - 0
docs/usage/guides/bundler/debian.md → docs/guides/bundler/debian.md


+ 0 - 0
docs/usage/guides/bundler/introduction.md → docs/guides/bundler/introduction.md


+ 0 - 0
docs/usage/guides/bundler/sidecar.md → docs/guides/bundler/sidecar.md


+ 0 - 0
docs/usage/guides/bundler/sign-osx.md → docs/guides/bundler/sign-osx.md


+ 0 - 0
docs/usage/guides/cli.md → docs/guides/cli.md


+ 0 - 0
docs/usage/guides/command.md → docs/guides/command.md


+ 0 - 0
docs/usage/contributor-guide.md → docs/guides/contributor-guide.md


+ 0 - 0
docs/usage/guides/events.md → docs/guides/events.md


+ 0 - 0
docs/usage/guides/visual/icons.md → docs/guides/icons.md


+ 0 - 0
docs/usage/guides/visual/menu.md → docs/guides/menu.md


+ 0 - 0
docs/usage/guides/migration.md → docs/guides/migration.md


+ 0 - 0
docs/usage/guides/utils/multiwindow.md → docs/guides/multiwindow.md


+ 0 - 0
docs/usage/patterns/about-patterns.md → docs/guides/patterns/about-patterns.md


+ 0 - 0
docs/usage/patterns/bridge.md → docs/guides/patterns/bridge.md


+ 0 - 0
docs/usage/patterns/cloudbridge.md → docs/guides/patterns/cloudbridge.md


+ 0 - 0
docs/usage/patterns/cloudish.md → docs/guides/patterns/cloudish.md


+ 0 - 0
docs/usage/patterns/glui.md → docs/guides/patterns/glui.md


+ 0 - 0
docs/usage/patterns/hermit.md → docs/guides/patterns/hermit.md


+ 1 - 1
docs/usage/patterns/lockdown.md → 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
 

+ 0 - 0
docs/usage/patterns/multiwin.md → docs/guides/patterns/multiwin.md


+ 0 - 0
docs/usage/guides/plugin.md → docs/guides/plugin.md


+ 0 - 0
docs/usage/guides/visual/splashscreen.md → docs/guides/splashscreen.md


+ 0 - 0
docs/usage/guides/visual/system-tray.md → docs/guides/system-tray.md


+ 0 - 0
docs/usage/guides/updater.md → docs/guides/updater.md


+ 0 - 0
docs/usage/guides/webdriver/ci.md → docs/guides/webdriver/ci.md


+ 0 - 0
docs/usage/guides/webdriver/example/selenium.md → docs/guides/webdriver/example/selenium.md


+ 0 - 0
docs/usage/guides/webdriver/example/setup.md → docs/guides/webdriver/example/setup.md


+ 0 - 0
docs/usage/guides/webdriver/example/webdriverio.md → docs/guides/webdriver/example/webdriverio.md


+ 0 - 0
docs/usage/guides/webdriver/introduction.md → docs/guides/webdriver/introduction.md


+ 0 - 0
docs/usage/guides/visual/window-customization.md → docs/guides/window-customization.md


+ 54 - 69
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",
+        "label": "Patterns",
         "type": "category",
         "items": [
-          "usage/development/integration",
-          "usage/development/development",
-          "usage/development/debugging",
-          "usage/development/publishing",
-          "usage/development/updating"
+          "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": "Patterns",
+        "label": "Bundler",
         "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/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": "Guides",
+        "label": "WebDriver Testing",
         "type": "category",
         "items": [
-          "usage/guides/migration",
+          "guides/webdriver/introduction",
           {
-            "label": "Bundler",
+            "label": "Example Application",
             "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"
+              "guides/webdriver/example/setup",
+              "guides/webdriver/example/webdriverio",
+              "guides/webdriver/example/selenium"
             ]
           },
-          "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/webdriver/ci"
         ]
       },
-      {
-        "label": "CI/CD",
-        "type": "category",
-        "items": ["usage/ci-cd/workflow", "usage/ci-cd/cross-platform"]
-      },
-      "usage/contributor-guide"
+      "guides/migration",
+      "guides/contributor-guide"
     ]
   },
   {

+ 1 - 1
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