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,12 +1,15 @@
|
||||
---
|
||||
title: Remote Development - Zed
|
||||
description: Edit code on remote servers with Zed. Local UI performance with remote language servers, terminals, and tasks over SSH.
|
||||
title: Remote Development in Zed - SSH Workflows
|
||||
description: Use remote development in Zed to edit code over SSH with local UI performance, remote terminals, language servers, and tasks.
|
||||
---
|
||||
|
||||
# Remote Development
|
||||
|
||||
Remote Development lets you edit code on a remote server while running Zed locally. The UI stays responsive because it runs on your machine, while language servers, tasks, and terminals run on the server.
|
||||
|
||||
For day-to-day workflows, pair remote development with [Tasks](./tasks.md),
|
||||
[Terminal](./terminal.md), and [Debugger](./debugger.md).
|
||||
|
||||
## Overview
|
||||
|
||||
Remote development requires two computers, your local machine that runs the Zed UI and the remote server which runs a Zed headless server. The two communicate over SSH, so you will need to be able to SSH from your local machine into the remote server to use this feature.
|
||||
@@ -177,7 +180,7 @@ When opening a remote project there are three relevant settings locations:
|
||||
- The server Zed settings (in the same place) on the remote server.
|
||||
- The project settings (in `.zed/settings.json` or `.editorconfig` of your project)
|
||||
|
||||
Both the local Zed and the server Zed read the project settings, but they are not aware of the other's main `settings.json`.
|
||||
Both the local Zed and the server Zed read the project settings, but they are not aware of the other's main settings file.
|
||||
|
||||
Which settings file you should use depends on the kind of setting you want to make:
|
||||
|
||||
@@ -258,3 +261,13 @@ Note that we deliberately disallow some options (for example `-t` or `-T`) that
|
||||
## Feedback
|
||||
|
||||
Please join the #remoting-feedback channel in the [Zed Discord](https://zed.dev/community-links).
|
||||
|
||||
## See also
|
||||
|
||||
- [Running & Testing](./running-testing.md): Run tasks, terminal commands, and
|
||||
debugger sessions while you work remotely.
|
||||
- [Configuring Zed](./configuring-zed.md): Manage shared and project settings,
|
||||
including `.zed/settings.json`.
|
||||
- [Agent Panel](./ai/agent-panel.md): Use AI workflows in remote projects.
|
||||
- [Remote Development on zed.dev](https://zed.dev/remote-development): Product
|
||||
overview and release updates.
|
||||
Reference in new issue
Block a user