Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ pre-fills a new PR's base with the repo's default branch, which is
opened against `main`, click *Edit* next to the PR title and change the
base — the commits and the discussion carry over. A bot will remind you.

## Layout

```
src/ React 19 + Tailwind 4 interface
src-tauri/ Tauri 2 shell: supervises the local core, connects to a
local or remote core, draws the menu bar item and the tray
menu, sends system notifications, installs updates
src-tauri/crates/ tw-adopt (pointing clients at the gateway, MCP configuration)
and tw-scan (scanning client configuration)
scripts/shots/ the product screenshot pipeline (see CONTRIBUTING.md)
```

The gateway itself lives in ThinkWatch Core; this repository holds no routing,
forwarding, or accounting logic. The app reaches core's control channel over a
unix socket on macOS and Linux and over a loopback port on Windows, or over a
TCP port when core runs on a server. Every connection begins with an encrypted
handshake (Noise `NNpsk0`) keyed with the control key from core's
configuration (`listen.control.key`); no TLS certificates are involved.

## Scope, so you don't build something that gets declined

These decisions are settled and not up for a PR:
Expand Down
627 changes: 60 additions & 567 deletions README.md

Large diffs are not rendered by default.

275 changes: 26 additions & 249 deletions README.zh-CN.md

Large diffs are not rendered by default.

Binary file modified docs/screenshots/en/clients-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/clients-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/dry-run-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/dry-run-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/keys-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/keys-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/menubar-menu-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/menubar-menu-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/overview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/overview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-add-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-add-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-clients-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-clients-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-switcher-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/remote-switcher-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/routing-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/routing-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/security-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/security-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/settings-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/settings-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/traffic-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/traffic-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/upstreams-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/en/upstreams-light.png
Binary file modified docs/screenshots/menubar-dark.png
Binary file modified docs/screenshots/menubar-light.png
Binary file modified docs/screenshots/web/clients-en.webp
Binary file modified docs/screenshots/web/clients.webp
Binary file modified docs/screenshots/web/dry-run-en.webp
Binary file modified docs/screenshots/web/dry-run.webp
Binary file modified docs/screenshots/web/keys-en.webp
Binary file modified docs/screenshots/web/keys.webp
Binary file modified docs/screenshots/web/menubar-menu-en.webp
Binary file modified docs/screenshots/web/menubar-menu.webp
Binary file modified docs/screenshots/web/menubar.png
Binary file modified docs/screenshots/web/overview-en.webp
Binary file modified docs/screenshots/web/overview.webp
Binary file modified docs/screenshots/web/remote-add-en.webp
Binary file modified docs/screenshots/web/remote-add.webp
Binary file modified docs/screenshots/web/remote-clients-en.webp
Binary file modified docs/screenshots/web/remote-clients.webp
Binary file modified docs/screenshots/web/remote-switcher-en.webp
Binary file modified docs/screenshots/web/remote-switcher.webp
Binary file modified docs/screenshots/web/routing-en.webp
Binary file modified docs/screenshots/web/routing.webp
Binary file modified docs/screenshots/web/security-en.webp
Binary file modified docs/screenshots/web/security.webp
Binary file modified docs/screenshots/web/settings-en.webp
Binary file modified docs/screenshots/web/settings.webp
Binary file modified docs/screenshots/web/traffic-en.webp
Binary file modified docs/screenshots/web/traffic.webp
Binary file modified docs/screenshots/web/upstreams-en.webp
Binary file modified docs/screenshots/web/upstreams.webp
Binary file modified docs/screenshots/zh/clients-dark.png
Binary file modified docs/screenshots/zh/clients-light.png
Binary file modified docs/screenshots/zh/dry-run-dark.png
Binary file modified docs/screenshots/zh/dry-run-light.png
Binary file modified docs/screenshots/zh/keys-dark.png
Binary file modified docs/screenshots/zh/keys-light.png
Binary file modified docs/screenshots/zh/menubar-menu-dark.png
Binary file modified docs/screenshots/zh/menubar-menu-light.png
Binary file modified docs/screenshots/zh/overview-dark.png
Binary file modified docs/screenshots/zh/overview-light.png
Binary file modified docs/screenshots/zh/remote-add-dark.png
Binary file modified docs/screenshots/zh/remote-add-light.png
Binary file modified docs/screenshots/zh/remote-clients-dark.png
Binary file modified docs/screenshots/zh/remote-clients-light.png
Binary file modified docs/screenshots/zh/remote-switcher-dark.png
Binary file modified docs/screenshots/zh/remote-switcher-light.png
Binary file modified docs/screenshots/zh/routing-dark.png
Binary file modified docs/screenshots/zh/routing-light.png
Binary file modified docs/screenshots/zh/security-dark.png
Binary file modified docs/screenshots/zh/security-light.png
Binary file modified docs/screenshots/zh/settings-dark.png
Binary file modified docs/screenshots/zh/settings-light.png
Binary file modified docs/screenshots/zh/traffic-dark.png
Binary file modified docs/screenshots/zh/traffic-light.png
Binary file modified docs/screenshots/zh/upstreams-dark.png
Binary file modified docs/screenshots/zh/upstreams-light.png
Loading