Skip to content

Fixes for AI docs - #58969

Merged
macraig merged 2 commits into
mainfrom
ai-docs-audit
Jun 11, 2026
Merged

Fixes for AI docs#58969
macraig merged 2 commits into
mainfrom
ai-docs-audit

Conversation

@macraig

@macraig macraig commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Audited the AI documentation against the implementation

Changes

  • tool-permissions: skill tool patterns match the absolute SKILL.md path, not the skill name (fixed the table, example pattern, and added a clarifying note).
  • external-agents: Gemini CLI receives Zed's Google AI key when no env key is set; extension-provided agents are deprecated in favor of the ACP registry.
  • inline-assistant: alternatives run alongside the inline assistant model (not just the default model); fixed a broken anchor and gpt-4-minigpt-5-mini model id typos.
  • mcp: corrected the extensions menu item name ("Install New Servers…"), the remote server url example, and removed the nonexistent thinking tool from the profile example.
  • agent-panel: "New From Summary" lives in the New Thread menu; corrected the @-mention type list (no "instruction files"; added Fetch and Branch Diff).
  • use-api-access: DeepSeek default api_url includes /v1.
  • skills: folder name is a convention not a requirement; long descriptions warn rather than fail (measured in bytes); hidden skills are also @-mentionable; dropped the unenforced consecutive-hyphen rule; reconciled the no-remote-registry note with GitHub import.
  • edit-prediction: alt-tab and alt-l are bound across platforms; predictions are throttled rather than fired on every keystroke.
  • getting-started, windows-and-projects, parallel-agents: Panel Layout lives in the title-bar user menu, with workspace::UseAgenticLayout/UseClassicLayout action references.

Release Notes:

  • N/A

@cla-bot cla-bot Bot added the cla-signed The user has signed the Contributor License Agreement label Jun 9, 2026
@zed-community-bot zed-community-bot Bot added the staff Pull requests authored by a current member of Zed staff label Jun 9, 2026
@macraig macraig changed the title Fix inaccurate claims in AI documentation Fixes for AI docs Jun 9, 2026
Comment thread docs/src/ai/edit-prediction.md
Comment thread docs/src/ai/edit-prediction.md
Comment thread docs/src/ai/external-agents.md
macraig and others added 2 commits June 11, 2026 10:20
Correct several factual errors in the AI docs found by auditing against
the implementation:

- tool-permissions: skill tool patterns match the absolute SKILL.md path,
  not the skill name
- external-agents: Gemini CLI receives Zed's Google AI key; extension
  agents are deprecated in favor of the ACP registry
- inline-assistant: alternatives run alongside the inline assistant model
  (not just the default model); fix broken anchor and model id typos
- mcp: correct the extensions menu item name, the remote server url
  example, and drop the nonexistent thinking tool
- agent-panel: New From Summary lives in the New Thread menu; fix the
  mention type list
- use-api-access: DeepSeek default api_url includes /v1
- skills: folder name is a convention not a requirement; long descriptions
  warn rather than fail; hidden skills are also @-mentionable; drop the
  unenforced consecutive-hyphen rule; reconcile the no-remote-registry note
  with GitHub import
- edit-prediction: alt-tab/alt-l are bound on all platforms; predictions
  are throttled rather than per-keystroke
- getting-started, windows-and-projects, parallel-agents: Panel Layout is
  in the title-bar user menu
@macraig
macraig added this pull request to the merge queue Jun 11, 2026
@probably-neb

Copy link
Copy Markdown
Collaborator

@zed-zippy approve

Merged via the queue into main with commit cfc5f26 Jun 11, 2026
32 checks passed
@macraig
macraig deleted the ai-docs-audit branch June 11, 2026 15:20
@macraig

macraig commented Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

/cherry-pick stable

@zed-zippy

zed-zippy Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

🍒💥 Cherry-pick did not succeed
https://github.com/zed-industries/zed/actions/runs/27426851745

@macraig

macraig commented Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

/cherry-pick preview

zed-zippy Bot added a commit that referenced this pull request Jun 12, 2026
Cherry-pick of #58969 to preview

----
Audited the AI documentation against the implementation

## Changes

- **tool-permissions**: `skill` tool patterns match the absolute
`SKILL.md` path, not the skill name (fixed the table, example pattern,
and added a clarifying note).
- **external-agents**: Gemini CLI receives Zed's Google AI key when no
env key is set; extension-provided agents are deprecated in favor of the
ACP registry.
- **inline-assistant**: alternatives run alongside the inline assistant
model (not just the default model); fixed a broken anchor and
`gpt-4-mini` → `gpt-5-mini` model id typos.
- **mcp**: corrected the extensions menu item name ("Install New
Servers…"), the remote server `url` example, and removed the nonexistent
`thinking` tool from the profile example.
- **agent-panel**: "New From Summary" lives in the New Thread menu;
corrected the `@`-mention type list (no "instruction files"; added Fetch
and Branch Diff).
- **use-api-access**: DeepSeek default `api_url` includes `/v1`.
- **skills**: folder name is a convention not a requirement; long
descriptions warn rather than fail (measured in bytes); hidden skills
are also `@`-mentionable; dropped the unenforced consecutive-hyphen
rule; reconciled the no-remote-registry note with GitHub import.
- **edit-prediction**: `alt-tab` and `alt-l` are bound across platforms;
predictions are throttled rather than fired on every keystroke.
- **getting-started, windows-and-projects, parallel-agents**: Panel
Layout lives in the title-bar user menu, with
`workspace::UseAgenticLayout`/`UseClassicLayout` action references.

Release Notes:

- N/A

---------

Co-authored-by: zed-zippy[bot]
<234243425+zed-zippy[bot]@users.noreply.github.com>

Co-authored-by: María Craig <maria@zed.dev>
Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
This was referenced Jun 18, 2026
jonx pushed a commit to jonx/zed-aros that referenced this pull request Jul 17, 2026
Audited the AI documentation against the implementation

## Changes

- **tool-permissions**: `skill` tool patterns match the absolute
`SKILL.md` path, not the skill name (fixed the table, example pattern,
and added a clarifying note).
- **external-agents**: Gemini CLI receives Zed's Google AI key when no
env key is set; extension-provided agents are deprecated in favor of the
ACP registry.
- **inline-assistant**: alternatives run alongside the inline assistant
model (not just the default model); fixed a broken anchor and
`gpt-4-mini` → `gpt-5-mini` model id typos.
- **mcp**: corrected the extensions menu item name ("Install New
Servers…"), the remote server `url` example, and removed the nonexistent
`thinking` tool from the profile example.
- **agent-panel**: "New From Summary" lives in the New Thread menu;
corrected the `@`-mention type list (no "instruction files"; added Fetch
and Branch Diff).
- **use-api-access**: DeepSeek default `api_url` includes `/v1`.
- **skills**: folder name is a convention not a requirement; long
descriptions warn rather than fail (measured in bytes); hidden skills
are also `@`-mentionable; dropped the unenforced consecutive-hyphen
rule; reconciled the no-remote-registry note with GitHub import.
- **edit-prediction**: `alt-tab` and `alt-l` are bound across platforms;
predictions are throttled rather than fired on every keystroke.
- **getting-started, windows-and-projects, parallel-agents**: Panel
Layout lives in the title-bar user menu, with
`workspace::UseAgenticLayout`/`UseClassicLayout` action references.

Release Notes:

- N/A

---------

Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
jolutz pushed a commit to jolutz/zed that referenced this pull request Aug 8, 2026
…d-industries#59203)

Cherry-pick of zed-industries#58969 to preview

----
Audited the AI documentation against the implementation

## Changes

- **tool-permissions**: `skill` tool patterns match the absolute
`SKILL.md` path, not the skill name (fixed the table, example pattern,
and added a clarifying note).
- **external-agents**: Gemini CLI receives Zed's Google AI key when no
env key is set; extension-provided agents are deprecated in favor of the
ACP registry.
- **inline-assistant**: alternatives run alongside the inline assistant
model (not just the default model); fixed a broken anchor and
`gpt-4-mini` → `gpt-5-mini` model id typos.
- **mcp**: corrected the extensions menu item name ("Install New
Servers…"), the remote server `url` example, and removed the nonexistent
`thinking` tool from the profile example.
- **agent-panel**: "New From Summary" lives in the New Thread menu;
corrected the `@`-mention type list (no "instruction files"; added Fetch
and Branch Diff).
- **use-api-access**: DeepSeek default `api_url` includes `/v1`.
- **skills**: folder name is a convention not a requirement; long
descriptions warn rather than fail (measured in bytes); hidden skills
are also `@`-mentionable; dropped the unenforced consecutive-hyphen
rule; reconciled the no-remote-registry note with GitHub import.
- **edit-prediction**: `alt-tab` and `alt-l` are bound across platforms;
predictions are throttled rather than fired on every keystroke.
- **getting-started, windows-and-projects, parallel-agents**: Panel
Layout lives in the title-bar user menu, with
`workspace::UseAgenticLayout`/`UseClassicLayout` action references.

Release Notes:

- N/A

---------

Co-authored-by: zed-zippy[bot]
<234243425+zed-zippy[bot]@users.noreply.github.com>

Co-authored-by: María Craig <maria@zed.dev>
Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
jolutz pushed a commit to jolutz/zed that referenced this pull request Aug 8, 2026
Audited the AI documentation against the implementation

## Changes

- **tool-permissions**: `skill` tool patterns match the absolute
`SKILL.md` path, not the skill name (fixed the table, example pattern,
and added a clarifying note).
- **external-agents**: Gemini CLI receives Zed's Google AI key when no
env key is set; extension-provided agents are deprecated in favor of the
ACP registry.
- **inline-assistant**: alternatives run alongside the inline assistant
model (not just the default model); fixed a broken anchor and
`gpt-4-mini` → `gpt-5-mini` model id typos.
- **mcp**: corrected the extensions menu item name ("Install New
Servers…"), the remote server `url` example, and removed the nonexistent
`thinking` tool from the profile example.
- **agent-panel**: "New From Summary" lives in the New Thread menu;
corrected the `@`-mention type list (no "instruction files"; added Fetch
and Branch Diff).
- **use-api-access**: DeepSeek default `api_url` includes `/v1`.
- **skills**: folder name is a convention not a requirement; long
descriptions warn rather than fail (measured in bytes); hidden skills
are also `@`-mentionable; dropped the unenforced consecutive-hyphen
rule; reconciled the no-remote-registry note with GitHub import.
- **edit-prediction**: `alt-tab` and `alt-l` are bound across platforms;
predictions are throttled rather than fired on every keystroke.
- **getting-started, windows-and-projects, parallel-agents**: Panel
Layout lives in the title-bar user menu, with
`workspace::UseAgenticLayout`/`UseClassicLayout` action references.

Release Notes:

- N/A

---------

Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The user has signed the Contributor License Agreement staff Pull requests authored by a current member of Zed staff

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants