From ce5d597efa54e5374399d3cd79e76254582da91c Mon Sep 17 00:00:00 2001 From: "Joseph T. Lyons" Date: Tue, 21 Oct 2025 12:39:10 -0400 Subject: [PATCH] Centralize Zed.log documentation (#40808) Just wanted a single location to point people to for telling them where to find their log file. I left duplicate text in GitHub Issue templates, as it seems annoying to have to follow a link when making an issue. Release Notes: - N/A --- .github/ISSUE_TEMPLATE/11_crash_report.yml | 3 ++- docs/src/SUMMARY.md | 1 + docs/src/troubleshooting.md | 16 ++++++++++++++++ extensions/slash-commands-example/README.md | 3 +-- 4 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 docs/src/troubleshooting.md diff --git a/.github/ISSUE_TEMPLATE/11_crash_report.yml b/.github/ISSUE_TEMPLATE/11_crash_report.yml index aa736c75341512442720c202a4cadbf51bf253c8..1300809a39c6ecd9a10eb6a28e80ef4478dba6b5 100644 --- a/.github/ISSUE_TEMPLATE/11_crash_report.yml +++ b/.github/ISSUE_TEMPLATE/11_crash_report.yml @@ -33,9 +33,10 @@ body: required: true - type: textarea attributes: - label: If applicable, attach your `~/Library/Logs/Zed/Zed.log` file to this issue. + label: If applicable, attach your `Zed.log` file to this issue. description: | macOS: `~/Library/Logs/Zed/Zed.log` + Windows: `C:\Users\YOU\AppData\Local\Zed\logs\Zed.log` Linux: `~/.local/share/zed/logs/Zed.log` or $XDG_DATA_HOME If you only need the most recent lines, you can run the `zed: open log` command palette action to see the last 1000. value: | diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 086f8394d639994b808c4e390653f65bf9978d7a..1620998baf2b575da9d9e990d467f152f988c5fa 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -9,6 +9,7 @@ - [Windows](./windows.md) - [Telemetry](./telemetry.md) - [Workspace Persistence](./workspace-persistence.md) +- [Troubleshooting](./troubleshooting.md) - [Additional Learning Materials](./additional-learning-materials.md) # Configuration diff --git a/docs/src/troubleshooting.md b/docs/src/troubleshooting.md new file mode 100644 index 0000000000000000000000000000000000000000..50ce1bcc40680cfaa08f56a9c7e44ce5d4df893d --- /dev/null +++ b/docs/src/troubleshooting.md @@ -0,0 +1,16 @@ +# Troubleshooting + +## Zed Log + +Often, a good first place to look when troubleshooting any issue in Zed is the Zed log, which might contain clues about what's going wrong. +You can review the most recent 1000 lines of the log by running the {#action zed::OpenLog} command from the command palette (`cmd-shift-p` on macOS or `ctrl-shift-p` on Windows/Linux). +If you want to view the full file, you can find it at the respective location on each operating system: + +- macOS: `~/Library/Logs/Zed/Zed.log` +- Windows: `C:\Users\YOU\AppData\Local\Zed\logs\Zed.log` +- Linux: `~/.local/share/zed/logs/Zed.log` or `$XDG_DATA_HOME` + +> Note: In some cases, it might be useful to monitor the log live, such as when [developing a Zed extension](https://zed.dev/docs/extensions/developing-extensions). +> Example: `tail -f ~/Library/Logs/Zed/Zed.log` + +The log may contain enough context to help you debug the issue yourself, or you may find specific errors that are useful when filing a [GitHub Issue](https://github.com/zed-industries/zed/issues/new/choose) or when talking to Zed staff in our [Discord server](https://zed.dev/community-links#forums-and-discussions). diff --git a/extensions/slash-commands-example/README.md b/extensions/slash-commands-example/README.md index 6ff00dd2ad673bda951ba323258cfc3db2511c90..8c16a4e168a3334d3197090837eeaf21c956b3c3 100644 --- a/extensions/slash-commands-example/README.md +++ b/extensions/slash-commands-example/README.md @@ -76,8 +76,7 @@ Rebuild to see these changes reflected: ## Troubleshooting / Logs -- MacOS: `tail -f ~/Library/Logs/Zed/Zed.log` -- Linux: `tail -f ~/.local/share/zed/logs/Zed.log` +- [zed.dev docs: Troubleshooting](https://zed.dev/docs/troubleshooting) ## Documentation