From 667bf62396cb039d9571314d2fec30eb3f7b7171 Mon Sep 17 00:00:00 2001 From: Thomas Camlong Date: Sat, 1 Aug 2026 23:36:38 +0200 Subject: [PATCH] docs(dev): document remote PR builds --- apps/docs/docs/advanced/command-line/development/index.mdx | 4 ++-- tools/homarr-dev/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/docs/docs/advanced/command-line/development/index.mdx b/apps/docs/docs/advanced/command-line/development/index.mdx index a43f58c1a..dd74f1920 100644 --- a/apps/docs/docs/advanced/command-line/development/index.mdx +++ b/apps/docs/docs/advanced/command-line/development/index.mdx @@ -10,7 +10,7 @@ To install an optional `homarr` binary, run `pnpm dev:cli:install` and make your pnpm dev:cli -- dev ``` -The interactive browser combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to rebuild a local image, or use `p` to pull a remote preview. +The interactive browser combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to build a remote pull request locally or rebuild a local image, or use `p` to pull a remote preview. ## Build images @@ -19,7 +19,7 @@ pnpm dev:cli -- build pnpm dev:cli -- build --pr [name] ``` -The first command builds the current checkout as `homarr:`. The pull-request form clones the requested branch into a temporary directory and defaults to `homarr:pr-` when `name` is omitted. +The first command builds the current checkout as `homarr:`. The pull-request form uses a depth-one clone in a temporary directory and defaults to `homarr:pr-` when `name` is omitted. ## Rebuild images diff --git a/tools/homarr-dev/README.md b/tools/homarr-dev/README.md index e0ea4489b..5227eed33 100644 --- a/tools/homarr-dev/README.md +++ b/tools/homarr-dev/README.md @@ -66,7 +66,7 @@ homarr doctor Check Docker and optional CLI integrations / Filter by PR number, title, author, branch, CI, image, state, or port ↑/↓ or j/k Select Enter or Space Pull latest image and start, or stop when already running -R Rebuild a local image from its checkout or PR +R Build a remote PR locally or rebuild a local image p Pull a remote PR image and redeploy, preserving port and volume m Toggle demo mode for the next launch o Open PR on GitHub