diff --git a/README.md b/README.md index 584d2b1d..5d04954b 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ For the full set of build, test, and Android helper scripts, see |-------|----------| | Architecture overview & subsystem docs | [docs/architecture/](docs/architecture/) | | Requirements, traceability & technical debt | [docs/requirements.md](docs/requirements.md) | -| Build & release process | [docs/build-release.md](docs/build-release.md) | +| Build & release process | [docs/build/build-release.md](docs/build/build-release.md) | | Docker builds | [docs/build/docker.md](docs/build/docker.md) | | Traceability tooling & CI | [docs/traceability.md](docs/traceability.md), [docs/traceability-ci.md](docs/traceability-ci.md) | | Release checklist | [docs/release-checklist.md](docs/release-checklist.md) | diff --git a/docs-site/SUMMARY.md b/docs-site/SUMMARY.md index df4c2ee7..855a495e 100644 --- a/docs-site/SUMMARY.md +++ b/docs-site/SUMMARY.md @@ -71,10 +71,10 @@ # Build & Release -- [Build & Release](build-release.md) +- [Build & Release](build/build-release.md) - [Release Checklist](release-checklist.md) -- [Desktop Packaging](build-desktop-packages.md) -- [Windows Build](build-windows.md) +- [Desktop Packaging](build/build-desktop-packages.md) +- [Windows Build](build/build-windows.md) - [Defect Windows](defect-windows.md) - [Docker](build/docker.md) - [Builder Image](build/build-builder-image.md) diff --git a/docs/build-desktop-packages.md b/docs/build/build-desktop-packages.md similarity index 90% rename from docs/build-desktop-packages.md rename to docs/build/build-desktop-packages.md index b46dbd6d..a9984f2f 100644 --- a/docs/build-desktop-packages.md +++ b/docs/build/build-desktop-packages.md @@ -6,14 +6,14 @@ run in Docker so no host toolchain setup is required. Outputs land in `./dist`. ## One builder image (shared with CI) The deb/rpm and Windows-cross flows build on the **unified registry builder** -([../Dockerfile.builder](../Dockerfile.builder) → +([../Dockerfile.builder](../../Dockerfile.builder) → `gitea.tourolle.paris/dtourolle/jellytau-builder`), the same image CI uses. It carries every packaging tool: Android SDK/NDK, `rpm`/`file` (Linux bundler), `cargo-xwin` + `lld` + `llvm` + `nsis` + the `x86_64-pc-windows-msvc` rust target (Windows). There is **one** dependency source of truth — no per-stage tool installs. -The desktop stages in [../Dockerfile](../Dockerfile) are thin `FROM +The desktop stages in [../Dockerfile](../../Dockerfile) are thin `FROM ${BUILDER_IMAGE}` environments; the actual build runs at container-run time on your bind-mounted source (like the `dev` service), so source edits need no image rebuild. @@ -28,7 +28,7 @@ docker build -f Dockerfile.builder -t jellytau-builder:latest . BUILDER_IMAGE=jellytau-builder:latest bun run docker:build:windows ``` -Arch uses a separate `archlinux` image ([../Dockerfile.arch](../Dockerfile.arch)) +Arch uses a separate `archlinux` image ([../Dockerfile.arch](../../Dockerfile.arch)) because `makepkg` is Arch-specific — it is not part of the unified builder. | Target | Format | Docker command | Functional? | @@ -40,7 +40,7 @@ because `makepkg` is Arch-specific — it is not part of the unified builder. ## Linux: deb + rpm Tauri's bundler produces these natively. The build runs on the existing Ubuntu -builder image ([../Dockerfile](../Dockerfile), `desktop-linux-build` stage): +builder image ([../Dockerfile](../../Dockerfile), `desktop-linux-build` stage): ```bash bun run docker:build:linux # deb + rpm -> ./dist @@ -58,8 +58,8 @@ transcoded video). The deb/rpm declare these. **Tauri has no `pacman` bundle target** (as of tauri-cli 2.9.x — valid targets are deb/rpm/appimage/msi/nsis/app/dmg). So we ship a hand-written PKGBUILD in -[../packaging/arch/PKGBUILD](../packaging/arch/PKGBUILD) and build it with -`makepkg` on an Arch base image ([../Dockerfile.arch](../Dockerfile.arch)): +[../packaging/arch/PKGBUILD](../../packaging/arch/PKGBUILD) and build it with +`makepkg` on an Arch base image ([../Dockerfile.arch](../../Dockerfile.arch)): ```bash bun run docker:build:arch # .pkg.tar.zst -> ./dist diff --git a/docs/build-release.md b/docs/build/build-release.md similarity index 98% rename from docs/build-release.md rename to docs/build/build-release.md index 7e18ce9a..7edd7382 100644 --- a/docs/build-release.md +++ b/docs/build/build-release.md @@ -294,8 +294,8 @@ bun run tauri build # Local build test ``` ### Documentation -1. Update [CHANGELOG.md](../CHANGELOG.md) with changes -2. Update [README.md](../README.md) with new features +1. Update [CHANGELOG.md](../../CHANGELOG.md) with changes +2. Update [README.md](../../README.md) with new features 3. Document breaking changes 4. Add migration guide if needed diff --git a/docs/build-windows.md b/docs/build/build-windows.md similarity index 92% rename from docs/build-windows.md rename to docs/build/build-windows.md index 44d75542..ccd94290 100644 --- a/docs/build-windows.md +++ b/docs/build/build-windows.md @@ -12,10 +12,10 @@ job / SMTC lockscreen), but it runs and plays media. h264 fine. No Windows-specific code. - **Audio-only (music)** — the native audio backends are libmpv (Linux) and ExoPlayer (Android); neither exists on Windows. Instead - `create_player_backend()` in [../src-tauri/src/lib.rs](../src-tauri/src/lib.rs) + `create_player_backend()` in [../src-tauri/src/lib.rs](../../src-tauri/src/lib.rs) uses `WebviewAudioBackend` on non-Linux/non-Android targets: it hands the stream URL to a webview `