yenru0/zed

0 Fork 0

Files

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

4.3 KiB

Raw Blame History

title, description

title	description
Getting Started with Zed	Get started with Zed, the fast open-source code editor. Essential commands, environment setup, and navigation basics.

Getting Started

Zed is an open-source code editor with built-in collaboration and AI tools.

This guide covers the essential commands, environment setup, and navigation basics.

Quick Start

Welcome Page

When you open Zed without a folder, you see the welcome page in the main editor area. The welcome page offers quick actions to open a folder, clone a repository, or view documentation. Once you open a folder or file, the welcome page disappears. If you split the editor into multiple panes, the welcome page appears only in the center pane when empty—other panes show a standard empty state.

To reopen the welcome page, close all items in the center pane or use the command palette to search for "Welcome".

1. Open a Project

Open a folder from the command line:

zed ~/projects/my-app

Or use Cmd+O (macOS) / Ctrl+O (Linux/Windows) to open a folder from within Zed.

By default, new projects open in your current window's threads sidebar. To open in a new window instead, use zed -n ~/projects/my-app or press Cmd+Enter when selecting from Open Recent. See Windows & Projects for more details.

2. Learn the Essential Commands

Action	macOS	Linux/Windows
Command palette	`Cmd+Shift+P`	`Ctrl+Shift+P`
Go to file	`Cmd+P`	`Ctrl+P`
Go to symbol	`Cmd+Shift+O`	`Ctrl+Shift+O`
Find in project	`Cmd+Shift+F`	`Ctrl+Shift+F`
Toggle terminal	Ctrl+`	Ctrl+`
Open settings	`Cmd+,`	`Ctrl+,`

The command palette (Cmd+Shift+P) is your gateway to every action in Zed. If you forget a shortcut, search for it there.

Panel Layout

Use Panel Layout > Agentic from the user menu in the title bar (or the {#action workspace::UseAgenticLayout} action) when you want the Agent Panel and Threads Sidebar next to each other on the left. Use Panel Layout > Classic (or {#action workspace::UseClassicLayout}) to restore the editor-oriented layout.

3. Configure Your Editor

Open the Settings Editor with Cmd+, (macOS) or Ctrl+, (Linux/Windows). Search for any setting and change it directly.

Common first changes:

Theme: Press Cmd+K Cmd+T (macOS) or Ctrl+K Ctrl+T (Linux/Windows) to open the theme selector
Font: Search for buffer_font_family in Settings
Format on save: Search for format_on_save and set to on

4. Set Up Your Language

Zed includes built-in support for many languages. For others, install the extension:

Open Extensions with Cmd+Shift+X (macOS) or Ctrl+Shift+X (Linux/Windows)
Search for your language
Click Install

See Languages for language-specific setup instructions.

5. Try AI Features

Zed includes built-in AI assistance. Open the Agent Panel with Cmd+Shift+A (macOS) or Ctrl+Shift+A (Linux/Windows) to start a conversation, or use Cmd+Enter (macOS) / Ctrl+Enter (Linux/Windows) for inline assistance.

See AI Overview to configure providers and learn what's possible.

Coming from Another Editor?

We have dedicated guides for switching from other editors:

VS Code — Import settings, map keybindings, find equivalent features
IntelliJ IDEA — Adapt to Zed's approach to navigation and refactoring
PyCharm — Set up Python development in Zed
WebStorm — Configure JavaScript/TypeScript workflows
RustRover — Rust development in Zed

You can also enable familiar keybindings:

Vim: Enable vim_mode in settings. See Vim Mode.
Helix: Enable helix_mode in settings. See Helix Mode.

Join the Community

Zed is open source. Join us on GitHub or in Discord to contribute code, report bugs, or suggest features.

4.3 KiB Raw Blame History