From a4f7747c7382e2116ed2f29ffefd028d3cd043f0 Mon Sep 17 00:00:00 2001 From: Phileas Lebada Date: Fri, 8 Aug 2025 22:44:03 +0100 Subject: [PATCH] Improve extension development docs (#33646) I'm installing an extension for the first time from source and assumed that the sentence > If you already have a published extension with the same name installed, your dev extension will override it. also means that it would override the already installed extension. Besides that I've had to use `--foreground` mode to also get more meaningful error messages under NixOS without using `programs.nix-ld.enabled = true;`. Release Notes: - Improved Zed documentation for extension development --------- Co-authored-by: Peter Tripp --- docs/src/extensions/developing-extensions.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/src/extensions/developing-extensions.md b/docs/src/extensions/developing-extensions.md index 97af1f2673..947956f5b7 100644 --- a/docs/src/extensions/developing-extensions.md +++ b/docs/src/extensions/developing-extensions.md @@ -19,10 +19,16 @@ Before starting to develop an extension for Zed, be sure to [install Rust via ru When developing an extension, you can use it in Zed without needing to publish it by installing it as a _dev extension_. -From the extensions page, click the `Install Dev Extension` button and select the directory containing your extension. +From the extensions page, click the `Install Dev Extension` button (or the {#action zed::InstallDevExtension} action) and select the directory containing your extension. + +If you need to troubleshoot, you can check the Zed.log ({#action zed::OpenLog}) for additional output. For debug output, close and relaunch zed with the `zed --foreground` from the command line which show more verbose INFO level logging. If you already have a published extension with the same name installed, your dev extension will override it. +After installing the `Extensions` page will indicate that that the upstream extension is "Overridden by dev extension". + +Pre-installed extensions with the same name have to be uninstalled before installing the dev extension. See [#31106](https://github.com/zed-industries/zed/issues/31106) for more. + ## Directory Structure of a Zed Extension A Zed extension is a Git repository that contains an `extension.toml`. This file must contain some