docs: Testing automatic documentation updates locally (2025-12-21) by morgankrey · Pull Request #45503 · zed-industries/zed

morgankrey · 2025-12-22T00:42:48Z

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 - 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:

The new automatic @mention formatting behavior
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

## 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 | | `docs/src/configuring-languages.md` | Minor formatting fix: removed extra blank line before list | Prettier compliance | | `docs/src/configuring-zed.md` | Minor formatting fix: removed extra blank line before list | Prettier compliance | | `docs/src/development.md` | Minor formatting fix: removed extra blank lines before numbered sub-steps | Prettier compliance | | `docs/src/extensions/themes.md` | Minor formatting fix: removed extra blank lines before lists in theme component descriptions | Prettier compliance | | `docs/src/languages/r.md` | Minor formatting fix: removed extra blank line before nested list item | Prettier compliance | | `docs/src/vim.md` | Minor formatting fix: removed extra blank line before list | Prettier compliance | ### 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. The remaining changes are formatting corrections to comply with Prettier's markdown formatting rules, removing extraneous blank lines before list items that were flagged during the formatting check. ### 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 - **Uncertainty addressed**: The Phase 4 flag about Mercury/Sweep providers was resolved by confirming they are behind feature flags and correctly excluded from documentation - **Formatting changes**: The 6 formatting fixes are mechanical Prettier compliance changes with no semantic impact Triggered by: PR #44505 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>

Now I have enough context to generate the documentation update summary: --- ## Documentation Update Summary ### Changes Made | File | Change | Related Code | | --- | --- | --- | | `docs/src/ai/edit-prediction.md` | Updated GitHub Copilot sign-in instructions to describe the new popup window flow with device code display, copy button, and "Connect to GitHub" button | PR #30239 (`e9a756b5fc`) | | `docs/src/ai/edit-prediction.md` | Updated Codestral setup instructions to direct users to Settings Editor → Edit Predictions instead of Agent Panel | PR #44505 (`0283bfb049`) | ### Rationale These documentation updates reflect two UI changes in Zed: 1. **Copilot Sign-in Flow**: The sign-in process was redesigned from a simple status bar prompt to a dedicated popup window (`CopilotCodeVerification`) that displays the device code with copy functionality and a "Connect to GitHub" button. The window auto-closes on successful authorization. The previous documentation was too vague ("follow the setup instructions"). 2. **Codestral Configuration**: Edit prediction providers can now be configured through the graphical Settings Editor rather than requiring users to navigate to the Agent Panel settings view. This provides a more discoverable and consistent configuration experience. ### Review Notes - **Keyboard shortcuts**: The Codestral section now includes platform-specific shortcuts (`Cmd+,` / `Ctrl+,`). Reviewers should verify these match the current keybindings. - **Consistency**: Both changes improve documentation specificity by describing exact UI elements rather than generic "follow instructions" language. - **No skipped changes**: All planned updates from Phase 4 were successfully applied. - **Formatting verified**: File passes Prettier 80-character line width check. --- ### Condensed Version (for commit message) ``` docs: Update edit prediction provider setup instructions - Copilot: Document new popup sign-in flow with device code display - Codestral: Direct to Settings Editor instead of Agent Panel Reflects UI changes from PRs #30239 and #44505. ``` Triggered by: PR #44505 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>

## Documentation Update Summary ### Changes Made | File | Change | Related Code | | --- | --- | --- | | `docs/src/ai/agent-panel.md` | Added documentation for cycling through favorited models via `{#kb agent::CycleFavoriteModels}` keybinding | `agent::CycleFavoriteModels` action | ### Rationale The `agent::CycleFavoriteModels` action was identified as an undocumented keybinding in the agent panel. This feature allows users to quickly switch between their favorited models without opening the model selector dropdown, providing a more efficient workflow for users who frequently switch between a set of preferred models. ### Review Notes - **Placement**: The new sentence was added directly after the existing paragraph about the model selector, maintaining logical flow within the "Changing Models" section - **Style compliance**: Uses second person ("you can cycle"), present tense, and the `{#kb ...}` preprocessor syntax for dynamic keybinding display - **No hedging**: Follows documentation guidelines by stating functionality directly without qualifiers like "might" or "should" - **Prerequisite mentioned**: The sentence clarifies that users need "favorited models configured" as a prerequisite for this feature to be useful ### Condensed Commit Message ``` docs: Add CycleFavoriteModels keybinding documentation Document the agent::CycleFavoriteModels action in the agent panel docs, explaining how users can cycle through favorited models without opening the model selector. ``` Triggered by: PR #45032 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>

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 ``` Triggered by: PR #44914 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>

This PR fixes the Edit Prediction docs for Codestral after they got mangled in #45503. Release Notes: - N/A

@probably-neb

…45503) ## 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](#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>

This PR fixes the Edit Prediction docs for Codestral after they got mangled in #45503. Release Notes: - N/A

@probably-neb

…ed-industries#45503) ## 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**: [zed-industries#44914](zed-industries#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 zed-industries#45254 | ### Rationale PR zed-industries#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 zed-industries#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>

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

@probably-neb

…ed-industries#45503) ## 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**: [zed-industries#44914](zed-industries#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 zed-industries#45254 | ### Rationale PR zed-industries#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 zed-industries#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>

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

@probably-neb

…ed-industries#45503) ## 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**: [zed-industries#44914](zed-industries#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 zed-industries#45254 | ### Rationale PR zed-industries#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 zed-industries#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>

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

cla-bot bot added the cla-signed The user has signed the Contributor License Agreement label Dec 22, 2025

Autofix

6b54785

maxdeviant changed the title ~~docs: automated documentation update (2025-12-21)~~ docs: Automated documentation update (2025-12-21) Dec 22, 2025

morgankrey and others added 4 commits December 21, 2025 18:53

Autofix

9482e78

morgankrey changed the title ~~docs: Automated documentation update (2025-12-21)~~ docs: Allow local testing of automated documentation updates (2025-12-21) Dec 22, 2025

morgankrey changed the title ~~docs: Allow local testing of automated documentation updates (2025-12-21)~~ docs: Testing automatic documentation updates locally (2025-12-21) Dec 22, 2025

morgankrey merged commit 9adb3e1 into main Dec 22, 2025
27 checks passed

morgankrey deleted the docs/auto-update-2025-12-21 branch December 22, 2025 02:31

maxdeviant mentioned this pull request Dec 22, 2025

docs: Fix Edit Prediction docs for Codestral #45509

Merged

maxdeviant added a commit that referenced this pull request Dec 22, 2025

docs: Fix Edit Prediction docs for Codestral (#45509)

397fcf6

This PR fixes the Edit Prediction docs for Codestral after they got mangled in #45503. Release Notes: - N/A

rtfeldman pushed a commit that referenced this pull request Jan 5, 2026

docs: Fix Edit Prediction docs for Codestral (#45509)

e7f752f

This PR fixes the Edit Prediction docs for Codestral after they got mangled in #45503. Release Notes: - N/A

LivioGama pushed a commit to LivioGama/zed that referenced this pull request Jan 20, 2026

docs: Fix Edit Prediction docs for Codestral (zed-industries#45509)

6cb0e40

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

LivioGama pushed a commit to LivioGama/zed that referenced this pull request Jan 20, 2026

docs: Fix Edit Prediction docs for Codestral (zed-industries#45509)

71d1acf

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

LivioGama pushed a commit to LivioGama/zed that referenced this pull request Feb 15, 2026

docs: Fix Edit Prediction docs for Codestral (zed-industries#45509)

ec13734

This PR fixes the Edit Prediction docs for Codestral after they got mangled in zed-industries#45503. Release Notes: - N/A

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Testing automatic documentation updates locally (2025-12-21)#45503

docs: Testing automatic documentation updates locally (2025-12-21)#45503
morgankrey merged 6 commits intomainfrom
docs/auto-update-2025-12-21

morgankrey commented Dec 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

morgankrey commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Update Summary

Changes Made

Rationale

Review Notes

Update from 2025-12-21 20:25

Documentation Update Summary

Changes Made

Rationale

Review Notes

Condensed Version (for commit message)

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

morgankrey commented Dec 22, 2025 •

edited

Loading