Xin Zhao
6aa90e750d
docs: Update actions format ( #54869 )
...
Congratsbot / check-author (push) Waiting to run
Congratsbot / congrats (push) Blocked by required conditions
deploy_nightly_docs / deploy_docs (push) Waiting to run
run_tests / check_postgres_and_protobuf_migrations (push) Blocked by required conditions
run_tests / orchestrate (push) Waiting to run
run_tests / check_style (push) Waiting to run
run_tests / extension_tests (push) Blocked by required conditions
run_tests / clippy_windows (push) Blocked by required conditions
run_tests / clippy_linux (push) Blocked by required conditions
run_tests / clippy_mac (push) Blocked by required conditions
run_tests / clippy_mac_x86_64 (push) Blocked by required conditions
run_tests / run_tests_windows (push) Blocked by required conditions
run_tests / run_tests_linux (push) Blocked by required conditions
run_tests / run_tests_mac (push) Blocked by required conditions
run_tests / doctests (push) Blocked by required conditions
run_tests / check_workspace_binaries (push) Blocked by required conditions
run_tests / build_visual_tests_binary (push) Blocked by required conditions
run_tests / check_wasm (push) Blocked by required conditions
run_tests / check_dependencies (push) Blocked by required conditions
run_tests / check_docs (push) Blocked by required conditions
run_tests / check_licenses (push) Blocked by required conditions
run_tests / check_scripts (push) Blocked by required conditions
run_tests / tests_pass (push) Blocked by required conditions
Self-Review Checklist:
- [ ] I've reviewed my own diff for quality, security, and reliability
- [ ] Unsafe blocks (if any) have justifying comments
- [ ] The content is consistent with the [UI/UX
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist )
- [ ] Tests cover the new/changed behavior
- [ ] Performance impact has been considered and is acceptable
Change the actions in docs to adopt the right format.
Release Notes:
- N/A
2026-05-07 06:55:11 +00:00
Ben Kunkle
1bfd77b398
Fix docs validation to detect unknown keys ( #49660 )
...
Closes #ISSUE
Release Notes:
- N/A *or* Added/Fixed/Improved ...
---------
Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com>
2026-02-19 20:46:21 -05:00
morgankrey
6daa541e77
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
Haojian Wu
63918b8955
docs: Document implemented clangd extensions ( #44308 )
...
Zed currently doesn’t support all protocol extensions implemented by
`clangd`, but it does support two:
- `textDocument/inactiveRegion`
- `textDocument/switchSourceHeader`
Release Notes:
- N/A
---------
Co-authored-by: Kunall Banerjee <hey@kimchiii.space>
2025-12-15 02:16:48 -05:00
Peter Tripp
51e97d343d
languages: Recognize .clangd as YAML ( #43557 )
...
Follow-up to: https://github.com/zed-industries/zed/pull/43469
Thanks @WeetHet for [the idea]([WeetHet](https://github.com/WeetHet )).
Release Notes:
- Added support for identifying. .clangd files as YAML by default
2025-11-26 15:55:23 +01:00
Seeni
a660a39ae8
docs: Update cpp.md to indicate GDB version requirements ( #40027 )
...
Release Notes:
- N/A
---------
Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
Co-authored-by: Marshall Bowers <git@maxdeviant.com>
2025-10-17 21:02:53 +00:00
Mikayla Maki
908ae95cf8
docs: Improve debug adapter documentation ( #40441 )
...
docs. docs. docs.
Release Notes:
- N/A
2025-10-17 00:36:47 +00:00
Ben Kunkle
abe1fd5e16
docs: Validate JSON snippets (settings, keymap, tasks, etc) ( #40043 )
...
Closes #ISSUE
Release Notes:
- N/A *or* Added/Fixed/Improved ...
2025-10-12 00:19:57 -04:00
HE7086
d342da4e9a
docs: Fix typos in language configurations ( #37740 )
...
Fixes several typos in the docs. I think there are more but I have only
read what I actually needed :)
Release Notes:
- N/A
2025-09-08 08:44:46 +00:00
Lukas Wirth
fca44f89c1
languages: Allow installing pre-release of rust-analyzer and clangd ( #37530 )
...
Release Notes:
- Added lsp binary config to allow fetching nightly rust-analyzer and
clangd releases
2025-09-04 09:22:19 +00:00
Haojian Wu
993d5753d5
docs: Add a missing "," in the C/C++ debugger configuration ( #35098 )
...
Release Notes:
- N/A
2025-07-25 16:14:44 +00:00
Cole Miller
b7bfdd3383
Move language-specific debugging docs to the page for each language ( #33692 )
...
Release Notes:
- N/A
2025-07-01 20:02:12 +00:00
Marshall Bowers
3b3c379852
docs: Fix casing of "Tree-sitter" ( #25427 )
...
This PR fixes the casing of "Tree-sitter" in the docs.
It is "Tree-sitter", not "Tree Sitter" or "Tree-Sitter".
Release Notes:
- N/A
2025-02-23 15:30:10 +00:00
Justin Simon
bbce1c19d1
Add compile_commands.json documentation for C/C++ ( #22639 )
...
Added documentation explaining that clangd requires
`compile_commands.json` for proper functionality in both C and C++
projects. Includes instructions for generating the file using CMake.
This is related to
https://github.com/zed-industries/zed/discussions/6480
Release Notes:
- N/A
---------
Co-authored-by: Peter Tripp <peter@zed.dev>
2025-01-06 21:42:00 +00:00
Alexandre Hamez
2af9fa7785
docs: Add missing ':' ( #21751 )
...
Release Notes:
- N/A
2024-12-09 12:22:19 -05:00
Peter Tripp
3a319e6cbe
docs: Improve formatter docs. Examples for C/C++ ( #20553 )
2024-11-13 09:24:50 -05:00
Alvaro Gaona
44dc693d30
docs: Update C# and C++ configuration pages ( #19500 )
...
- Update C# configuration page.
- Fix typo in C++ configuration page.
Release Notes:
- N/A
2024-10-21 11:07:12 +03:00
Peter Tripp
0e22c9f275
docs: Add C++ clangd example arguments ( #19308 )
2024-10-16 16:07:05 -04:00
Alvaro Gaona
182230a0ba
Fix C++ configuration documentation ( #19258 )
...
- Update the binary JSON object
- Add .clangd configuration file summary
Release Notes:
- N/A
2024-10-16 08:45:26 +03:00
Marshall Bowers
01e40928d8
docs: Document configuring binary path for clangd ( #17433 )
...
This PR adds documentation for how to configure the binary path for
`clangd`.
Release Notes:
- N/A
2024-09-05 13:05:09 -04:00
Peter Tripp
eb3c4b0e46
Docs Party 2024 ( #15876 )
...
Co-authored-by: Raunak Raj <nkray21111983@gmail.com>
Co-authored-by: Thorsten Ball <mrnugget@gmail.com>
Co-authored-by: Bennet <bennet@zed.dev>
Co-authored-by: Marshall Bowers <elliott.codes@gmail.com>
Co-authored-by: Joseph T Lyons <JosephTLyons@gmail.com>
Co-authored-by: Mikayla <mikayla@zed.dev>
Co-authored-by: Jason <jason@zed.dev>
Co-authored-by: Antonio Scandurra <me@as-cii.com>
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
Co-authored-by: Marshall <marshall@zed.dev>
Co-authored-by: Nathan Sobo <nathan@zed.dev>
Co-authored-by: Jason Mancuso <7891333+jvmncs@users.noreply.github.com>
Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
2024-08-09 13:37:54 -04:00
Marshall Bowers
3a5d116ffe
docs: Update language docs and include links in the sidebar ( #13828 )
...
This PR updates the supported language docs and adds them to the sidebar
for better discoverability.
Release Notes:
- N/A
2024-07-04 11:08:38 -04:00
Brian Ginsburg
6cd306e4c9
docs: Add initial language settings documentation ( #6957 )
...
This pull request implements the following documentation changes:
- [x] Copy existing language settings docs from old docs repo
- [x] Add new pages for Zig, Haskell, Gleam, Deno and PureScript
- [x] Add `rust-analyzer` target directory section to Rust language page
Release Notes:
- Added initial language settings documentation
([#4264 ](https://github.com/zed-industries/zed/issues/4264 )).
2024-01-28 22:07:27 -05:00
