Drop settings that no longer exist from the reference (#64210)
# Objective Follow-up to #64196, which corrected documented default *values*. This one covers documented *settings* — four entries in the reference name settings that have been renamed, moved, or removed outright, so a reader who copies them gets a key Zed either ignores or silently rewrites on load. Each claim below links to the code that makes it true: | Documented as | Reality | Evidence | | --- | --- | --- | | `features` | Gone | [`m_2026_02_02/settings.rs#L19-L27`](https://github.com/zed-industries/zed/blob/977458038b62d8a989903aeb0f0c67cd12e8eb00/crates/migrator/src/migrations/m_2026_02_02/settings.rs#L19-L27) moves the provider out and deletes `features` once empty; no `pub features` exists in [`crates/settings_content/`](https://github.com/zed-industries/zed/tree/977458038b62d8a989903aeb0f0c67cd12e8eb00/crates/settings_content/src) | | `edit_prediction_provider` | `edit_predictions.provider` | same migration, plus [`default.json`](https://github.com/zed-industries/zed/blob/977458038b62d8a989903aeb0f0c67cd12e8eb00/assets/settings/default.json) ships `"edit_predictions": { "provider": "zed" }` | | `agent_font_size` | `agent_ui_font_size` | [`m_2025_10_03/settings.rs#L10-L11`](https://github.com/zed-industries/zed/blob/977458038b62d8a989903aeb0f0c67cd12e8eb00/crates/migrator/src/migrations/m_2025_10_03/settings.rs#L10-L11) — "Renames the setting `agent_font_size` to `agent_ui_font_size`" | | `projects_online_by_default` | Gone | no match in `crates/` or `assets/` | ## Solution `## Features` is deleted. Its only child, [Edit Prediction Provider](https://zed.dev/docs/reference/all-settings#edit-prediction-provider), moves under [Edit Predictions](https://zed.dev/docs/reference/all-settings#edit-predictions) to sit with the other `edit_predictions` settings, and its `Setting:` line becomes `provider`. Nothing else had to change in that subsection — its JSON examples already used the `edit_predictions.provider` shape, which is what made the stale wrapper easy to miss. `agent_font_size` is renamed in place, heading included. `projects_online_by_default` is removed. The Edit Predictions example also listed seven `disabled_globs` where `default.json` ships ten. #64196 corrected that number on the [Disabled Globs](https://zed.dev/docs/reference/all-settings#disabled-globs) entry immediately below it, so the two were contradicting each other on the same page; the example is now synced. ## Testing `cd docs && npx prettier --check src/` passes, per [`docs/AGENTS.md`](https://github.com/zed-industries/zed/blob/main/docs/AGENTS.md). Code fences stay balanced, the moved heading is unique on the page, and no page links to `#features`, `#agent-font-size`, `#projects-online-by-default`, or `#edit-prediction-provider`, so the restructure breaks no anchors. No `{#action}` or `{#kb}` references are added, so this does not depend on the action metadata `check_docs` generates. Found by extracting every ``Setting:`` name on the page and checking it against the keys `assets/settings/default.json` actually contains, then confirming each miss against `crates/settings_content/` and `crates/migrator/`. ## Notes for review - The same sweep says 24 scalar settings that `default.json` ships have no entry on this page at all, including `hide_mouse`, `word_diff_enabled`, `minimum_contrast_for_highlights`, `modeline_lines`, `lsp_results_location` and `zoomed_padding`. That is #53323 territory and a much larger piece of writing, so it is not here — happy to take it on if you want it. - `auto_update_extensions` and `terminal.font_features` are documented but absent from `default.json`. Both are real settings ([`extension.rs`](https://github.com/zed-industries/zed/blob/977458038b62d8a989903aeb0f0c67cd12e8eb00/crates/settings_content/src/extension.rs), [`terminal.rs`](https://github.com/zed-industries/zed/blob/977458038b62d8a989903aeb0f0c67cd12e8eb00/crates/settings_content/src/terminal.rs)) that simply have no shipped default, so I left them alone. - Still outstanding from #64196's review notes: `crates/settings_content/src/language.rs` and `editor.rs` carry `/// Default:` comments that feed the settings.json schema tooltips and still disagree with the site, and `docs/src/diagnostics.md` and `docs/src/visual-customization.md` still show the old `diagnostics_max_severity` and `cursor_shape` defaults. ## Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Release Notes: - N/A
This commit is contained in:
Rusty Raven authored and GitHub committed
1 parent
977458038b
commit
c7a50ea221
1 file changed
+44
-65
@@ -88,10 +88,10 @@ Non-negative `float` values
|
||||
}
|
||||
```
|
||||
|
||||
## Agent Font Size
|
||||
## Agent UI Font Size
|
||||
|
||||
- Description: The font size for text in the agent panel. Inherits the UI font size if unset.
|
||||
- Setting: `agent_font_size`
|
||||
- Setting: `agent_ui_font_size`
|
||||
- Default: `null`
|
||||
|
||||
**Options**
|
||||
@@ -700,13 +700,54 @@ For the case of "open", regular selection behavior can be achieved by holding `a
|
||||
"**/*.cert",
|
||||
"**/*.crt",
|
||||
"**/.dev.vars",
|
||||
"**/secrets.yml"
|
||||
"**/secrets.yml",
|
||||
"**/.zed/settings.json",
|
||||
"/**/zed/settings.json",
|
||||
"/**/zed/keymap.json"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Options**
|
||||
|
||||
### Edit Prediction Provider
|
||||
|
||||
- Description: Which edit prediction provider to use
|
||||
- Setting: `provider`
|
||||
- Default: `"zed"`
|
||||
|
||||
**Options**
|
||||
|
||||
1. Use Zeta as the edit prediction provider:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "zed"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Use Copilot as the edit prediction provider:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "copilot"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Turn off edit predictions across all providers
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "none"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Disabled Globs
|
||||
|
||||
- Description: A list of globs for which edit predictions should be disabled for. This list adds to a pre-existing, sensible default set of globs. Any additional ones you add are combined with them.
|
||||
@@ -1996,58 +2037,6 @@ While other options may be changed at a runtime and should be placed under `sett
|
||||
|
||||
`integer` values representing milliseconds
|
||||
|
||||
## Features
|
||||
|
||||
- Description: Features that can be globally enabled or disabled
|
||||
- Setting: `features`
|
||||
- Default:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "zed"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Edit Prediction Provider
|
||||
|
||||
- Description: Which edit prediction provider to use
|
||||
- Setting: `edit_prediction_provider`
|
||||
- Default: `"zed"`
|
||||
|
||||
**Options**
|
||||
|
||||
1. Use Zeta as the edit prediction provider:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "zed"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Use Copilot as the edit prediction provider:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "copilot"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Turn off edit predictions across all providers
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
"edit_predictions": {
|
||||
"provider": "none"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Focus Follows Mouse
|
||||
|
||||
- Description: Whether the focused panel follows the mouse location.
|
||||
@@ -3783,16 +3772,6 @@ Examples:
|
||||
|
||||
List of `string` glob patterns
|
||||
|
||||
## Projects Online By Default
|
||||
|
||||
- Description: Whether or not to show the online projects view by default.
|
||||
- Setting: `projects_online_by_default`
|
||||
- Default: `true`
|
||||
|
||||
**Options**
|
||||
|
||||
`boolean` values
|
||||
|
||||
## Read SSH Config
|
||||
|
||||
- Description: Whether to read SSH configuration files
|
||||
|
||||
Reference in new issue
Block a user