vrr/zed

mirror of https://github.com/zed-industries/zed.git synced 2026-05-30 11:54:03 +00:00

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

2026-02-17 20:58:17 -06:00

1.4 KiB

Raw Blame History

title	description
Building Zed for FreeBSD	Guide to building zed for freebsd for Zed development.

Building Zed for FreeBSD

FreeBSD is not currently a supported platform, so this guide is a work in progress.

Repository

Clone the Zed repository.

Dependencies

Install the necessary system packages and rustup:
```
script/freebsd
```
If preferred, you can inspect script/freebsd and perform the steps manually.

Building from source

Once the dependencies are installed, you can build Zed using Cargo.

For a debug build of the editor:

cargo run

And to run the tests:

cargo test --workspace

In release mode, the primary user interface is the cli crate. You can run it in development with:

cargo run -p cli

WebRTC Notice

Building webrtc-sys on FreeBSD currently fails due to missing upstream support and unavailable prebuilt binaries. As a result, collaboration features that depend on WebRTC (audio calls and screen sharing) are temporarily disabled.

See [Issue #15309: FreeBSD Support] and [Discussion #29550: Unofficial FreeBSD port for Zed] for more.

Troubleshooting

Cargo errors claiming that a dependency is using unstable features

Try cargo clean and cargo build.

1.4 KiB Raw Blame History