Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Add more improvements to the AI docs (#35160)

Browse source 
Follow-up to https://github.com/zed-industries/zed/pull/35133 with some
more findings upon re-reviewing it again.

Release Notes:

- N/A
This commit is contained in:
Danilo Leal 2025-07-27 14:06:18 -03:00 • committed by GitHub
parent c995d45bd9
commit e7b5d93b7c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 18 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/src/ai/agent-settings.md
View file

@ -6,13 +6,12 @@ Learn about all the settings you can customize in Zed's Agent Panel.
### Default Model {#default-model}
If you're using Zed's hosted LLM service, it sets `claude-sonnet-4` as the default model.
But if you're not subscribed to the hosted service or simply just want to change it, you can do it so either via the model dropdown in the Agent Panel's bottom-right corner or by manually editing the `default_model` object in your settings:
If you're using [Zed's hosted LLM service](./plans-and-usage.md), it sets `claude-sonnet-4` as the default model.
But if you're not subscribed to it or simply just want to change it, you can do it so either via the model dropdown in the Agent Panel's bottom-right corner or by manually editing the `default_model` object in your settings:
```json
{
"agent": {
"version": "2",
"default_model": {
"provider": "zed.dev",
"model": "gpt-4o"
@ -32,7 +31,6 @@ Assign distinct and specific models for the following AI-powered features in Zed
```json
{
"agent": {
"version": "2",
"default_model": {
"provider": "zed.dev",
"model": "claude-sonnet-4"
@ -53,7 +51,7 @@ Assign distinct and specific models for the following AI-powered features in Zed
}
```
> If a model isn't set for one of these features, they automatically fall back to using the default model.
> If a custom model isn't set for one of these features, they automatically fall back to using the default model.
### Alternative Models for Inline Assists {#alternative-assists}
@ -128,6 +126,7 @@ You can choose between `thread` (the default) and `text_thread`:
### Auto-run Commands
Control whether you want to allow the agent to run commands without asking you for permission.
The default value is `false`.
```json
{
@ -142,6 +141,7 @@ Control whether you want to allow the agent to run commands without asking you f
### Single-file Review
Control whether you want to see review actions (accept & reject) in single buffers after the agent is done performing edits.
The default value is `false`.
```json
{
@ -158,6 +158,7 @@ When set to false, these controls are only available in the multibuffer review t
### Sound Notification
Control whether you want to hear a notification sound when the agent is done generating changes or needs your input.
The default value is `false`.
```json
{
@ -173,6 +174,7 @@ Control whether you want to hear a notification sound when the agent is done gen
Make a modifier (`cmd` on macOS, `ctrl` on Linux) required to send messages.
This is encouraged for more thoughtful prompt crafting.
The default value is `false`.
```json
{
@ -213,6 +215,7 @@ It is set to `true` by default, but if set to false, the card will be fully coll
### Feedback Controls
Control whether you want to see the thumbs up/down buttons to give Zed feedback about the agent's performance.
The default value is `true`.
```json
{

7
docs/src/ai/billing.md
View file

@ -1,7 +1,7 @@
# Billing
We use Stripe as our billing and payments provider. All Pro plans require payment via credit card.
For invoice-based billing, a Business plan is required. Contact sales@zed.dev for more information.
For invoice-based billing, a Business plan is required. Contact [sales@zed.dev](mailto:sales@zed.dev) for more information.
## Settings {#settings}
@ -12,7 +12,8 @@ Clicking the button under Account Settings will navigate you to Stripe’s secur
Zed is billed on a monthly basis based on the date you initially subscribe.
We’ll also bill in-month for additional prompts used beyond your plan’s prompt limit, if usage exceeds $20 before month end. See [usage-based pricing](./plans-and-usage.md#ubp) for more.
We’ll also bill in-month for additional prompts used beyond your plan’s prompt limit, if usage exceeds $20 before month end.
See [usage-based pricing](./plans-and-usage.md#ubp) for more.
## Invoice History {#invoice-history}
@ -33,4 +34,4 @@ Zed partners with [Sphere](https://www.getsphere.com/) to calculate indirect tax
If you have a VAT/GST ID, you can add it at [zed.dev/account](https://zed.dev/account) by clicking "Manage" on your subscription. Check the box that denotes you as a business.
Please note that changes to VAT/GST IDs and address will **only** affect future invoices — **we cannot modify historical invoices**.
Questions or issues can be directed to billing-support@zed.dev.
Questions or issues can be directed to [billing-support@zed.dev](mailto:billing-support@zed.dev).

2
docs/src/ai/configuration.md
View file

@ -6,7 +6,7 @@ When using AI in Zed, you can customize several aspects:
2. [Model parameters and usage](./agent-settings.md#model-settings)
3. [Interactions with the Agent Panel](./agent-settings.md#agent-panel-settings)
## Turning AI off entirely
## Turning AI Off Entirely
We want to respect users who want to use Zed without interacting with AI whatsoever.
To do that, add the following key to your `settings.json`:

6
docs/src/ai/llm-providers.md
View file

@ -2,13 +2,13 @@
To use AI in Zed, you need to have at least one large language model provider set up.
You can do that by either subscribing to [one of Zed's plans](./subscription.md), or by using API keys you already have for the supported providers.
You can do that by either subscribing to [one of Zed's plans](./plans-and-usage.md), or by using API keys you already have for the supported providers.
## Use Your Own Keys {#use-your-own-keys}
If you already have an API key for an existing LLM provider—say Anthropic or OpenAI, for example—you can insert them in Zed and use the Agent Panel **_for free_**.
You can add your API key to a given provider either via the Agent Panel's settings UI or the `settings.json` directly, through the `language_models` key.
You can add your API key to a given provider either via the Agent Panel's settings UI or directly via the `settings.json` through the `language_models` key.
## Supported Providers
@ -25,7 +25,7 @@ Here's all the supported LLM providers for which you can use your own API keys:
| [Mistral](#mistral) | ✅ |
| [Ollama](#ollama) | ✅ |
| [OpenAI](#openai) | ✅ |
| [OpenAI API Compatible](#openai-api-compatible) | 🚫 |
| [OpenAI API Compatible](#openai-api-compatible) | ✅ |
| [OpenRouter](#openrouter) | ✅ |
| [Vercel](#vercel-v0) | ✅ |
| [xAI](#xai) | ✅ |

2
docs/src/ai/mcp.md
View file

@ -75,7 +75,7 @@ Mentioning your MCP server by name helps the agent pick it up.
If you want to ensure a given server will be used, you can create [a custom profile](./agent-panel.md#custom-profiles) by turning off the built-in tools (either all of them or the ones that would cause conflicts) and turning on only the tools coming from the MCP server.
As an example, [the Dagger team suggests](https://container-use.com/agent-integrations#add-container-use-agent-profile-optional) doing that with their [Container Use MCP server](https://zed.dev/extensions/container-use-mcp-server):
As an example, [the Dagger team suggests](https://container-use.com/agent-integrations#add-container-use-agent-profile-optional) doing that with their [Container Use MCP server](https://zed.dev/extensions/mcp-server-container-use):
```json
"agent": {

4
docs/src/ai/overview.md
View file

@ -6,9 +6,7 @@ Learn how to get started using AI with Zed and all its capabilities.
- [Configuration](./configuration.md): Learn how to set up different language model providers like Anthropic, OpenAI, Ollama, Google AI, and more.
- [Models](./models.md): Learn about the various language models available in Zed.
- [Subscription](./subscription.md): Learn about Zed's subscriptions and other billing-related information.
- [Subscription](./subscription.md): Learn about Zed's hosted model service and other billing-related information.
- [Privacy and Security](./privacy-and-security.md): Understand how Zed handles privacy and security with AI features.