Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Marking things as done #1

Closed
wants to merge 11 commits into from
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"starlight-blog": "^0.8.2",
"starlight-links-validator": "^0.9.0"
},
"packageManager": "pnpm@9.2.0",
"packageManager": "pnpm@9.3.0",
"engines": {
"pnpm": "^9.0.0"
}
Expand Down
18 changes: 0 additions & 18 deletions src/content/docs/concept/Inter-Process Communication/brownfield.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
title: Brownfield Pattern
sidebar:
badge:
text: WIP
variant: caution
---

_**This is the default pattern.**_
Expand All @@ -16,20 +12,6 @@ If you are unfamiliar with Brownfield software development in general, the [Brow
provides a nice summary. For Tauri, the existing software is current browser support and behavior, instead of
legacy systems.

## Incompatibilities

The first incompatibility category is simple: any browser-specific APIs will not work properly inside Tauri (even while
using the Brownfield pattern). If the API is not widely supported across browsers, it probably won't be supported
across all platforms while using Tauri.

The second incompatibility category is features that are planned for Tauri, but are currently not fully implemented. Here
is a list of examples:

- [WebRTC support on Linux](https://github.com/tauri-apps/wry/issues/85)
- [Some permissions APIs](https://github.com/tauri-apps/wry/issues/81)
- [Download Links/Blob as URL](https://github.com/tauri-apps/wry/issues/349)
- [Better i18n](https://github.com/tauri-apps/wry/issues/442)

## Configuration

Because the Brownfield pattern is the default pattern, it doesn't require a configuration option to be set. To explicitly set
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: Inter-Process Communication
sidebar:
label: Overview
order: 1
badge:
text: WIP
variant: caution
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
title: Isolation Pattern
sidebar:
badge:
text: WIP
variant: caution
---

The Isolation pattern is a way to intercept and modify Tauri API messages sent by the frontend before they get to Tauri Core, all with JavaScript. The secure JavaScript code that is injected by the Isolation pattern is referred to as the Isolation application.
Expand Down
9 changes: 0 additions & 9 deletions src/content/docs/concept/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Tauri Architecture
sidebar:
order: 0
badge:
text: WIP
variant: caution
---

## Introduction
Expand Down Expand Up @@ -160,12 +157,6 @@ GitHub workflow that builds Tauri binaries for all platforms. Even allows creati

This project enhances the Visual Studio Code interface with several nice-to-have features.

### vue-cli-plugin-tauri

[View on GitHub](https://github.com/tauri-apps/vue-cli-plugin-tauri)

Allows you to very quickly install Tauri in a vue-cli project.

## Plugins

[Tauri Plugin Guide](/develop/plugins)
Expand Down
3 changes: 0 additions & 3 deletions src/content/docs/concept/process-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Process Model
sidebar:
order: 0
badge:
text: WIP
variant: caution
---

Tauri employs a multi-process architecture similar to Electron or many modern web browsers. This guide explores the reasons behind the design choice and why it is key to writing secure applications.
Expand Down
3 changes: 0 additions & 3 deletions src/content/docs/concept/size.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: App Size
sidebar:
order: 0
badge:
text: WIP
variant: caution
---

import { Tabs, TabItem } from '@astrojs/starlight/components';
Expand Down
7 changes: 1 addition & 6 deletions src/content/docs/develop/Debug/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,8 @@ title: Debug
sidebar:
label: Overview
order: 10
badge:
text: WIP
variant: caution
---

{/* TODO: REVISE COPY TO V2 */}

import CommandTabs from '@components/CommandTabs.astro';

With all the moving pieces in Tauri, you may run into a problem that requires debugging. There are many locations where error details are printed, and Tauri includes some tools to make the debugging process more straightforward.
Expand All @@ -23,7 +18,7 @@ One of the most useful tools in your toolkit for debugging is the ability to add
```rs frame=none
fn main() {
// Tauri provided convenience function for whether you ran with `tauri dev`.
let is_dev: bool = tauri::dev();
let is_dev: bool = tauri::is_dev();
// If debug assertions are enabled or not.
#[cfg(debug_assertions)]
{
Expand Down
66 changes: 0 additions & 66 deletions src/content/docs/develop/Debug/intellij.mdx

This file was deleted.

8 changes: 2 additions & 6 deletions src/content/docs/develop/Debug/rustrover.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: Debug in RustRover
sidebar:
badge:
text: WIP
variant: caution
title: Debug with JetBrains
---

{/* TODO: Update links and internal navigation */}
{/* TODO: Add support to light/dark mode images */}

In this guide, we'll be setting up JetBrains RustRover for debugging the [Core Process of your Tauri app](/concept/process-model/#the-core-process).
This guide also mostly applies to IntelliJ or CLion.

## Setting up a Cargo project

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/develop/Debug/vscode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ title: Debug in VS Code
sidebar:
badge:
text: WIP
variant: caution
variant: note
---

{/* TODO: REVISE COPY TO V2 */}
{/* TODO: Check if the tauri plugin works fine with v2 and add it as a reference here */}
{/* TODO: Revise this change: Debugging in VS Code > Debug in VS Code */}

This guide will walk you through setting up VS Code for debugging the [Core Process of your Tauri app](/concept/process-model/#the-core-process).
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/Pipelines/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: GitHub
sidebar:
badge:
text: WIP
text: Stub
variant: caution
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/Pipelines/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: GitLab
sidebar:
badge:
text: WIP
text: Stub
variant: caution
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/Pipelines/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Overview
sidebar:
order: 10
badge:
text: WIP
text: Stub
variant: caution
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/WebDriver/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: WebDriver Testing
sidebar:
order: 21
badge:
text: WIP
text: Broken
variant: caution
---

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/develop/Tests/WebDriver/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 10
label: Overview
badge:
text: WIP
text: Broken
variant: caution
---

Expand Down Expand Up @@ -60,14 +60,14 @@ can look at https://github.com/chippers/hello_tauri.
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

<CardGrid>
<LinkCard title="Setup" href="/start/develop/tests/webdriver/example/" />
<LinkCard title="Setup" href="/develop/tests/webdriver/example/" />
<LinkCard
title="Selenium"
href="/start/develop/tests/webdriver/example/selenium"
href="/develop/tests/webdriver/example/selenium"
/>
<LinkCard
title="WebdriverIO"
href="/start/develop/tests/webdriver/example/webdriverio"
href="/develop/tests/webdriver/example/webdriverio"
/>
</CardGrid>

Expand All @@ -77,7 +77,7 @@ The above examples also comes with a CI script to test with GitHub actions, but

<LinkCard
title="Continuous Integration (CI)"
href="/start/develop/tests/webdriver/ci"
href="/develop/tests/webdriver/ci/"
/>

[webdriver]: https://www.w3.org/TR/webdriver/
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 10
label: Overview
badge:
text: WIP
text: Stub
variant: caution
---

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/Tests/mocking.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Mock Tauri APIs
sidebar:
order: 10
badge:
text: WIP
text: 1.x
variant: caution
---

Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/develop/calling-frontend.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Calling the Frontend from Rust
sidebar:
order: 1
badge:
text: Stub
variant: caution
---

{/* Add Events Page from v1 */}
3 changes: 0 additions & 3 deletions src/content/docs/develop/calling-rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Calling Rust from the Frontend
sidebar:
order: 1
badge:
text: WIP
variant: caution
---

Tauri provides a simple yet powerful `command` system for calling Rust functions from your web app.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/configuration-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Configuration Files
sidebar:
order: 1
badge:
text: WIP
text: "1.x"
variant: caution
---

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/develop/development-cycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Development Cycle
sidebar:
order: 1
badge:
text: WIP
text: "?"
variant: caution
---

{/* TODO: REVISE COPY TO V2 */}
{/* TODO: Add .taurignore or remove this page and add this content into overview */}

import CommandTabs from '@components/CommandTabs.astro';

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/develop/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 0
label: Overview
badge:
text: WIP
text: Stub
variant: caution
---

Expand Down
3 changes: 0 additions & 3 deletions src/content/docs/develop/sidecar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: Embedding External Binaries
sidebar:
order: 1
badge:
text: WIP
variant: caution
---

You may need to embed external binaries to add additional functionality to your application or prevent users from installing additional dependencies (e.g., Node.js or Python). We call this binary a `sidecar`.
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/develop/state-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: State Management
sidebar:
order: 1
badge:
text: Stub
variant: caution
---

import Stub from '@components/Stub.astro';
Expand Down
Loading
Loading