Files
zed/docs/src/diagnostics.md
T
morgankrey 526c95d474 Improve internal links across documentation (#64481)
## Summary

- Adds 63 internal links across 41 documentation pages.
- Connects existing terms such as Agent Panel, semantic tokens, edit
predictions, and language-specific debugging to their detailed reference
pages.
- Uses existing wording for 60 links and makes three small wording
changes where a natural anchor did not already exist.

## Why this matters

Readers can now move from overview and configuration pages to the
relevant detailed guidance without searching the documentation manually.
The changes add navigation only. They do not change product behavior or
documented requirements.

## Jev experiment

This PR came from a local experiment using Jev to audit internal links
across the published documentation. The audit scripts are not included
in this PR.

- Code shortlisted 2,715 possible source and destination page pairs.
- Jev made two separate decisions for each pair: whether the link would
help the reader, and which exact existing phrase should become the
anchor.
- Five strong links without existing anchor text went to GPT-5.6 Luna
for minimal rewrite options. Jev then selected among those fixed
options.
- A local review interface surfaced the results for Pass or Fail
decisions before any files changed.

Human review approved 66 changes. Two no longer matched the current
`main` branch, and review removed one circular link, leaving the 63
links in this PR.

## Validation

- `pnpm dlx prettier@3.5.0 <changed docs> --check`
- `lychee --exclude '^http' './docs/src/**/*'` — 0 errors
- `mdbook build docs`
- Verified that the diff adds exactly 63 Markdown links

Release Notes:

- Improved links between related documentation pages.
2026-09-19 19:58:09 +00:00

2.1 KiB

title, description
title description
Diagnostics - Errors and Warnings in Zed View and navigate errors, warnings, and code diagnostics from language servers in Zed.

Diagnostics

Zed gets its diagnostics from the language servers and supports both push and pull variants of the LSP which makes it compatible with all existing language servers.

Regular diagnostics

By default, Zed displays all diagnostics as underlined text in the editor and the scrollbar.

Editor diagnostics could be filtered with the

"diagnostics_max_severity": null

editor setting (possible values: "off", "error", "warning", "info", "hint", null (default, all diagnostics)).

The scrollbar ones are configured with the

"scrollbar": {
  "diagnostics": "all",
}

configuration (possible values: "none", "error", "warning", "information", "all" (default))

The diagnostics could be hovered to display a tooltip with a full, rendered diagnostic message. Or, editor::GoToDiagnostic and editor::GoToPreviousDiagnostic could be used to navigate between diagnostics in the editor, showing a popover for the currently active diagnostic.

Inline diagnostics (Error lens)

Zed supports showing diagnostics as a lens to the right of the code. This is disabled by default, but can either be temporarily turned on (or off) using the editor menu, or permanently, using the

"diagnostics": {
  "inline": {
    "enabled": true,
    "max_severity": null, // same values as the `diagnostics_max_severity` from the editor settings
  }
}

Other UI places

Project Panel

Project panel can have its entries coloured based on the severity of the diagnostics in the file.

To configure, use

"project_panel": {
  "show_diagnostics": "all",
}

configuration (possible values: "off", "errors", "all" (default))

Editor tabs

Similar to the project panel, editor tabs can be colorized with the

"tabs": {
  "show_diagnostics": "off",
}

configuration (possible values: "off" (default), "errors", "all")