vrr/zed

mirror of https://github.com/zed-industries/zed.git synced 2026-05-25 14:44:28 +00:00

docs: Add documentation conventions, brand voice guidelines, and gold standards (#49176 )

## Summary

This PR establishes the foundation for documentation quality and
automation.

## Documentation Conventions (`docs/.conventions/`)

**CONVENTIONS.md** - Structural guidelines covering:
- What needs documentation vs what to skip
- Page vs section decisions (with examples)
- Document structure and section ordering
- Formatting conventions (code, JSON, tables, callouts)
- Anchor ID patterns for stable deep-linking
- Settings documentation pattern (UI first, then JSON)
- Terminology standards (aligned with docs/AGENTS.md)
- Prettier formatting requirements

**brand-voice/** - Zed's writing style:
- `SKILL.md` - Core voice principles
- `rubric.md` - 8-point scoring criteria (must score 4+ on all)
- `taboo-phrases.md` - Patterns to avoid (exclamation points, hype
words)
- `voice-examples.md` - Before/after transformations

## Gold Standard Examples (`docs/.doc-examples/`)

Four templates demonstrating best practices:
- `simple-feature.md` - Overview/navigation docs
- `complex-feature.md` - Comprehensive feature docs
- `configuration.md` - Settings documentation
- `reference.md` - API/tool reference

## Related

Follow-up PR #49177 applies these conventions to existing documentation.

Release Notes:

- N/A

2026-02-14 14:20:03 -06:00

3.3 KiB

Raw Permalink Blame History

title: Finding and Navigating Code - Zed description: Navigate your codebase in Zed with file finder, project search, go to definition, symbol search, and the command palette.

Finding & Navigating

Zed provides several ways to move around your codebase quickly. Here's an overview of the main navigation tools.

Command Palette

The Command Palette ({#kb command_palette::Toggle}) is your gateway to almost everything in Zed. Type a few characters to filter commands, then press Enter to execute.

Learn more about the Command Palette →

File Finder

Open any file in your project with {#kb file_finder::Toggle}. Type part of the filename or path to narrow results.

Project Search

Search across all files with {#kb pane::DeploySearch}. Results appear in a multibuffer, letting you edit matches in place.

Go to Definition

Jump to where a symbol is defined with {#kb editor::GoToDefinition} (or Cmd+Click / Ctrl+Click). If there are multiple definitions, they open in a multibuffer.

Go to Symbol

Current file: {#kb outline::Toggle} opens an outline of symbols in the active file
Entire project: {#kb project_symbols::Toggle} searches symbols across all files

Outline Panel

The Outline Panel ({#kb outline_panel::ToggleFocus}) shows a persistent tree view of symbols in the current file. It's especially useful with multibuffers for navigating search results or diagnostics.

Learn more about the Outline Panel →

Tab Switcher

Quickly switch between open tabs with {#kb tab_switcher::Toggle}. Tabs are sorted by recent use—keep holding Ctrl and press Tab to cycle through them.

Learn more about the Tab Switcher →

Quick Reference

Task	Keybinding
Command Palette	{#kb command_palette::Toggle}
Open file	{#kb file_finder::Toggle}
Project search	{#kb pane::DeploySearch}
Go to definition	{#kb editor::GoToDefinition}
Find references	{#kb editor::FindAllReferences}
Symbol in file	{#kb outline::Toggle}
Symbol in project	{#kb project_symbols::Toggle}
Outline Panel	{#kb outline_panel::ToggleFocus}
Tab Switcher	{#kb tab_switcher::Toggle}

3.3 KiB Raw Permalink Blame History