From 875dfa0391221a27e2b65278b5740c274fbec05f Mon Sep 17 00:00:00 2001 From: nic <139033898+dicnunz@users.noreply.github.com> Date: Wed, 20 May 2026 16:08:30 -0400 Subject: [PATCH] docs: expose desktop install guide --- docs/guides/README.md | 1 + docs/guides/desktop-install.md | 10 ++++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/guides/README.md b/docs/guides/README.md index a1907dac..eb4630b3 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -7,6 +7,7 @@ Practical how-to guides for developing, deploying, and extending OpenSail. | Guide | Description | When to Use | |-------|-------------|-------------| | [Docker Setup](docker-setup.md) | Set up OpenSail from scratch with Docker Compose | **Start here**. First-time setup, new developers | +| [Desktop Install](desktop-install.md) | Install the desktop app or run the desktop client from source | Local-first use, desktop packaging, installer testing | | [Local Development](local-development.md) | Run backend/frontend natively (without Docker) | Faster iteration, debugging | | [Minikube Setup](minikube-setup.md) | Deploy to local Kubernetes cluster | Testing K8s features locally | | [AWS Deployment](aws-deployment.md) | Deploy to AWS EKS production | Production deployment | diff --git a/docs/guides/desktop-install.md b/docs/guides/desktop-install.md index e059a210..8666fdd1 100644 --- a/docs/guides/desktop-install.md +++ b/docs/guides/desktop-install.md @@ -42,13 +42,15 @@ Common to all platforms: ## 3. Install from release Direct downloads live at -[github.com/TesslateAI/opensail/releases](https://github.com/TesslateAI/opensail/releases). -Pick the latest tagged release and grab the artifact for your OS. +[github.com/TesslateAI/opensail/releases](https://github.com/TesslateAI/opensail/releases) +when a desktop release includes installer assets. If the latest release has no +desktop installer attached yet, use the build-from-source flow below. ### macOS (`.dmg`) 1. Download `OpenSail__aarch64.dmg` (Apple Silicon) or - `OpenSail__x64.dmg` (Intel). + `OpenSail__x64.dmg` (Intel) when those assets are attached to the + release. 2. Open the DMG and drag `OpenSail.app` into `/Applications`. 3. First launch: right-click the app, pick "Open", then "Open" again at the Gatekeeper prompt. Shipped builds are codesigned with a Developer ID and @@ -56,7 +58,7 @@ Pick the latest tagged release and grab the artifact for your OS. ### Windows (`.msi`) -1. Download `OpenSail__x64_en-US.msi`. +1. Download `OpenSail__x64_en-US.msi` when it is attached to the release. 2. Double-click and step through the installer. It installs to `%LOCALAPPDATA%\Programs\OpenSail` by default and pins a Start menu entry. 3. If SmartScreen flags the installer as "unrecognized", click "More info"