## 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
1.4 KiB
| title | description |
|---|---|
| Debugging Crashes | Guide to debugging crashes for Zed development. |
Debugging Crashes
When Zed panics or crashes, it sends a message to a sidecar process that inspects the editor's memory and creates a minidump in ~/Library/Logs/Zed or $XDG_DATA_HOME/zed/logs. You can use this minidump to generate backtraces for all thread stacks.
If telemetry is enabled, Zed uploads these reports when you restart the app. Reports are sent to a Slack channel and to Sentry (both are Zed-staff-only).
These crash reports include useful data, but they are hard to read without spans or symbol information. You can still analyze them locally by downloading source and an unstripped binary (or separate symbols file) for your Zed release, then running:
zstd -d ~/.local/share/zed/<uuid>.dmp -o minidump.dmp
minidump-stackwalk minidump.dmp
Alongside the minidump in your logs directory, you should also see a <uuid>.json file with metadata such as the panic message, span, and system specs.
Using a Debugger
If you can reproduce the crash consistently, use a debugger to inspect program state at the crash point.
For setup details, see Using a debugger.