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:
morgankrey authored and GitHub committed 2026-02-17 20:58:17 -06:00
1 parent 9743fe7dfd
commit 6daa541e77
142 files changed
+1947 -489

No files matched your search

+18 -5
View File
@@ -1,3 +1,8 @@
---
title: Python
description: "Configure Python language support in Zed, including language servers, formatting, and debugging."
---
# How to Set Up Python in Zed
Python support is available natively in Zed.
@@ -75,7 +80,9 @@ Other built-in language servers are:
- [Pyright](https://github.com/microsoft/pyright)—The basis for basedpyright.
- [PyLSP](https://github.com/python-lsp/python-lsp-server)—A plugin-based language server that integrates with tools like `pycodestyle`, `autopep8`, and `yapf`.
These are disabled by default, but can be enabled in your settings. For example:
These are disabled by default, but can be enabled in your settings.
Configure language servers in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file:
```json [settings]
{
@@ -116,7 +123,7 @@ Examples of both kinds of configuration are provided below. Refer to the basedpy
Language server settings for basedpyright in Zed can be set in the `lsp` section of your `settings.json`.
For example, in order to:
For example, to:
- diagnose all files in the workspace instead of the only open files default
- disable inlay hints on function arguments
@@ -194,7 +201,9 @@ Zed uses [Ruff](https://github.com/astral-sh/ruff) for formatting and linting Py
### Configuring Formatting
Formatting in Zed follows a two-phase pipeline: first, code actions on format (`code_actions_on_format`) are executed, followed by the configured formatter:
Formatting in Zed follows a two-phase pipeline: first, code actions on format (`code_actions_on_format`) are executed, followed by the configured formatter.
Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file:
```json [settings]
{
@@ -213,7 +222,9 @@ Formatting in Zed follows a two-phase pipeline: first, code actions on format (`
}
```
These two phases are independent. For example, if you prefer [Black](https://github.com/psf/black) for code formatting, but want to keep Ruff's import sorting, you only need to change the formatter phase:
These two phases are independent. For example, if you prefer [Black](https://github.com/psf/black) for code formatting, but want to keep Ruff's import sorting, you only need to change the formatter phase.
Configure in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file:
```json [settings]
{
@@ -237,7 +248,9 @@ These two phases are independent. For example, if you prefer [Black](https://git
To completely switch to another tool and prevent Ruff from modifying your code at all, you must explicitly set `source.organizeImports.ruff` to false in the `code_actions_on_format` section, in addition to changing the formatter.
To prevent any formatting actions when you save, you can disable format-on-save for Python files in your `settings.json`:
To prevent any formatting actions when you save, you can disable format-on-save for Python files.
Configure in Settings ({#kb zed::OpenSettings}) under Languages > Python, or add to your settings file:
```json [settings]
{