docs: Apply documentation standards across all docs (#49177)
## Summary
Comprehensive remediation of 146 documentation files to align with Zed's
documentation conventions and brand voice guidelines.
## Changes
### YAML Frontmatter
- Added `title` and `description` frontmatter to all docs missing it
### Settings UI Pattern
- Updated 48+ files to show Settings Editor before JSON examples
- Pattern: `Configure X in Settings ({#kb zed::OpenSettings}), or add to
your settings file:`
- Added `([how to edit](./configuring-zed.md#settings-files))` links for
JSON-only settings
### Brand Voice Fixes
- Removed exclamation points (command-palette, key-bindings, repl,
privacy-and-security, etc.)
- Simplified em dash chains to parentheticals (environment,
troubleshooting, agent-panel, etc.)
- Fixed marketing language (yarn.md intro, development/linux.md)
### Terminology Alignment
- `settings UI` -> `Settings Editor`
- `sidebar` -> specific panel names (Project Panel, Collab Panel)
- `directory` -> `folder` in non-technical contexts
- `workspace` -> `project` in non-LSP contexts
- `Command Palette` -> `command palette` (lowercase)
### Callout Standardization
- Converted various callout formats to standard `> **Note:**` pattern
## Related
Depends on conventions established in #49176.
Release Notes:
- N/A
This commit is contained in:
1 parent
9743fe7dfd
commit
6daa541e77
142 files changed
+1947
-489
No files matched your search
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: All Settings
|
||||
description: "Complete reference for all Zed settings."
|
||||
---
|
||||
|
||||
# All Settings
|
||||
|
||||
This is the complete reference for all Zed settings.
|
||||
@@ -6,7 +11,7 @@ You may also want to change your [theme](../themes.md), configure your [key bind
|
||||
|
||||
# Settings
|
||||
|
||||
Find below an extensive run-through of many supported settings by Zed.
|
||||
The sections below document supported Zed settings.
|
||||
|
||||
## Active Pane Modifiers
|
||||
|
||||
@@ -35,7 +40,7 @@ Non-negative `float` values
|
||||
|
||||
### Inactive Opacity
|
||||
|
||||
- Description: Opacity of inactive panels. When set to 1.0, the inactive panes have the same opacity as the active one. If set to 0, the inactive panes content will not be visible at all. Values are clamped to the [0.0, 1.0] range.
|
||||
- Description: Opacity of inactive panels. When set to 1.0, inactive panes have the same opacity as the active pane. If set to 0, inactive pane content is not visible. Values are clamped to the [0.0, 1.0] range.
|
||||
- Setting: `inactive_opacity`
|
||||
- Default: `1.0`
|
||||
|
||||
@@ -129,7 +134,7 @@ Note: This setting has no effect in Vim mode, as rewrap is already allowed every
|
||||
|
||||
## Auto Indent
|
||||
|
||||
- Description: Whether indentation should be adjusted based on the context whilst typing. This can be specified on a per-language basis.
|
||||
- Description: Whether indentation should be adjusted based on context while typing. This can be specified on a per-language basis.
|
||||
- Setting: `auto_indent`
|
||||
- Default: `true`
|
||||
|
||||
@@ -149,7 +154,7 @@ Note: This setting has no effect in Vim mode, as rewrap is already allowed every
|
||||
|
||||
## Auto Install extensions
|
||||
|
||||
- Description: Define extensions to be autoinstalled or never be installed.
|
||||
- Description: Define extensions to install automatically or never install.
|
||||
- Setting: `auto_install_extensions`
|
||||
- Default: `{ "html": true }`
|
||||
|
||||
@@ -239,7 +244,7 @@ Note that a save will be triggered when an unsaved tab is closed, even if this i
|
||||
|
||||
## Auto Signature Help
|
||||
|
||||
- Description: Show method signatures in the editor, when inside parentheses
|
||||
- Description: Show method signatures in the editor when inside parentheses.
|
||||
- Setting: `auto_signature_help`
|
||||
- Default: `false`
|
||||
|
||||
@@ -3270,6 +3275,18 @@ Non-negative `integer` values
|
||||
- Setting: `regex`
|
||||
- Default: `false`
|
||||
|
||||
### Search On Input
|
||||
|
||||
- Description: Whether to search on input in project search.
|
||||
- Setting: `search_on_input`
|
||||
- Default: `false`
|
||||
|
||||
### Search On Input Debounce Ms
|
||||
|
||||
- Description: Debounce time in milliseconds for search on input in project search. Set to 0 to disable debouncing.
|
||||
- Setting: `search_on_input_debounce_ms`
|
||||
- Default: `200`
|
||||
|
||||
### Center On Match
|
||||
|
||||
- Description: Whether to center the cursor on each search match when navigating.
|
||||
@@ -3282,12 +3299,6 @@ Non-negative `integer` values
|
||||
- Setting: `search_wrap`
|
||||
- Default: `true`
|
||||
|
||||
## Center on Match
|
||||
|
||||
- Description: If `center_on_match` is enabled, the editor will center the cursor on the current match when searching.
|
||||
- Setting: `center_on_match`
|
||||
- Default: `false`
|
||||
|
||||
## Seed Search Query From Cursor
|
||||
|
||||
- Description: When to populate a new search's query based on the text under the cursor.
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
---
|
||||
title: CLI Reference
|
||||
description: "Reference for Zed's command-line interface (CLI), including opening files and directories, integrating with tools, and controlling Zed from scripts."
|
||||
---
|
||||
|
||||
# CLI Reference
|
||||
|
||||
Zed includes a command-line interface (CLI) for opening files and directories, integrating with other tools, and controlling Zed from scripts.
|
||||
Use Zed's command-line interface (CLI) to open files and directories, integrate with other tools, and control Zed from scripts.
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@@ -1 +1,6 @@
|
||||
---
|
||||
title: Default Key Bindings
|
||||
description: "Reference for Zed's default key bindings."
|
||||
---
|
||||
|
||||
# Default Key Bindings
|
||||
Reference in new issue
Block a user