From 9adb3e1daae129270b7230c95bd3745c0451cfe4 Mon Sep 17 00:00:00 2001 From: morgankrey Date: Sun, 21 Dec 2025 20:31:24 -0600 Subject: [PATCH] docs: Testing automatic documentation updates locally (2025-12-21) (#45503) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Documentation Update Summary ### Changes Made | File | Change | Related Code | | --- | --- | --- | | `docs/src/ai/edit-prediction.md` | Updated Codestral setup instructions to use Settings Editor path instead of outdated `agent::OpenSettings` action reference | Settings Editor provider configuration flow | ### Rationale The primary documentation update addresses outdated instructions in the Codestral setup section. The original text referenced an `agent::OpenSettings` action that directed users to an "Agent Panel settings view" which no longer reflects the current UI flow. The updated instructions now guide users through the Settings Editor with platform-specific keyboard shortcuts and provide an alternative status bar path. ### Review Notes - **Codestral instructions**: Reviewers should verify the Settings Editor navigation path (`Cmd+,` → search "Edit Predictions" → **Configure Providers**) matches the current Zed UI - **Status bar alternative**: The alternative path via "edit prediction icon in the status bar" should be confirmed as accurate --- ## Update from 2025-12-21 20:25 --- **Source**: [#44914](https://github.com/zed-industries/zed/pull/44914) - settings_ui: Add Edit keybindings button **Author**: @probably-neb Now I have all the context needed to create a comprehensive documentation update summary. ## Documentation Update Summary ### Changes Made | File | Change | Related Code | | --- | --- | --- | | docs/src/ai/agent-panel.md | Added documentation for `agent::PasteRaw` action, explaining automatic @mention formatting for pasted code and how to bypass it | PR #45254 | ### Rationale PR #45254 ("agent_ui: Improve UX when pasting code into message editor") introduced the `agent::PasteRaw` action, which allows users to paste clipboard content without automatic formatting. When users copy multi-line code from an editor buffer and paste it into the Agent panel, Zed now automatically formats it as an @mention with file context. The `PasteRaw` action provides a way to bypass this behavior when raw text is preferred. This documentation update ensures users can discover both: 1. The new automatic @mention formatting behavior 2. The keybinding to bypass it when needed ### Review Notes - The new paragraph was placed in the "Adding Context" section, immediately after the existing note about image pasting support—this maintains logical flow since both relate to pasting behavior - Uses the standard `{#kb agent::PasteRaw}` syntax for keybinding references, consistent with other keybinding documentation in the file - The documentation passed Prettier formatting validation without modifications --- ### Condensed Version (for commit message) ``` docs(agent-panel): Document PasteRaw action for bypassing auto @mention formatting Added explanation that multi-line code pasted from editor buffers is automatically formatted as @mentions, with keybinding to paste raw text. Related: PR #45254 ``` Release Notes: - N/A --------- Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com> --- docs/src/ai/agent-panel.md | 4 ++++ docs/src/ai/edit-prediction.md | 20 ++++++++++++++++---- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/src/ai/agent-panel.md b/docs/src/ai/agent-panel.md index c383862ed631cbfdc42f591d63be09fb1209c8b8..0197bfb3ecc7b4ea245c6ce6963c3b592558a90f 100644 --- a/docs/src/ai/agent-panel.md +++ b/docs/src/ai/agent-panel.md @@ -85,6 +85,8 @@ You can type `@` to mention files, directories, symbols, previous threads, and r Copying images and pasting them in the panel's message editor is also supported. +When you paste multi-line code selections copied from an editor buffer, Zed automatically formats them as @mentions with the file context. To paste content without this automatic formatting, use {#kb agent::PasteRaw} to paste raw text directly. + ### Selection as Context Additionally, you can also select text in a buffer and add it as context by using the {#kb agent::AddSelectionToThread} keybinding, running the {#action agent::AddSelectionToThread} action, or choosing the "Selection" item in the `@` menu. @@ -100,6 +102,8 @@ You can also do this at any time with an ongoing thread via the "Agent Options" After you've configured your LLM providers—either via [a custom API key](./llm-providers.md) or through [Zed's hosted models](./models.md)—you can switch between them by clicking on the model selector on the message editor or by using the {#kb agent::ToggleModelSelector} keybinding. +If you have favorited models configured, you can cycle through them with {#kb agent::CycleFavoriteModels} without opening the model selector. + > The same model can be offered via multiple providers - for example, Claude Sonnet 4 is available via Zed Pro, OpenRouter, Anthropic directly, and more. > Make sure you've selected the correct model **_provider_** for the model you'd like to use, delineated by the logo to the left of the model in the model selector. diff --git a/docs/src/ai/edit-prediction.md b/docs/src/ai/edit-prediction.md index 65a427842cda461806dc79ecf67f3a180afd9763..74a85f566fae43d5696e14192c07ec1ca4f22d27 100644 --- a/docs/src/ai/edit-prediction.md +++ b/docs/src/ai/edit-prediction.md @@ -305,7 +305,7 @@ To use GitHub Copilot as your provider, set this within `settings.json`: } ``` -You should be able to sign-in to GitHub Copilot by clicking on the Copilot icon in the status bar and following the setup instructions. +To sign in to GitHub Copilot, click on the Copilot icon in the status bar. A popup window appears displaying a device code. Click the copy button to copy the code, then click "Connect to GitHub" to open the GitHub verification page in your browser. Paste the code when prompted. The popup window closes automatically after successful authorization. #### Using GitHub Copilot Enterprise @@ -348,10 +348,22 @@ You should be able to sign-in to Supermaven by clicking on the Supermaven icon i ### Codestral {#codestral} -To use Mistral's Codestral as your provider, start by going to the Agent Panel settings view by running the {#action agent::OpenSettings} action. -Look for the Mistral item and add a Codestral API key in the corresponding text input. +<<<<<<< Updated upstream +To use Mistral's Codestral as your provider: +======= +To use Mistral's Codestral as your provider, open the Settings Editor (`Cmd+,` on macOS, `Ctrl+,` on Linux/Windows) and navigate to the Edit Predictions section. Select Codestral as your provider and enter your API key in the corresponding field. -After that, you should be able to switch your provider to it in your `settings.json` file: +> > > > > > > Stashed changes + +1. Open the Settings Editor (`Cmd+,` on macOS, `Ctrl+,` on Linux/Windows) +2. Search for "Edit Predictions" and click **Configure Providers** +3. Find the Codestral section and enter your API key from the + [Codestral dashboard](https://console.mistral.ai/codestral) + +Alternatively, click the edit prediction icon in the status bar and select +**Configure Providers** from the menu. + +After adding your API key, set Codestral as your provider in `settings.json`: ```json [settings] {