Miguel Raz Guzmán Macedo
a2da6d971f
Fix grammatical errors throughout the documentation ( #58183 )
...
Fixes a batch of grammatical mistakes found across the `docs/` folder:
typos/misspellings, subject-verb agreement errors, missing and
duplicated words, article errors (`a`/`an`), wrong word forms, and
punctuation issues (doubled periods, unclosed parentheses).
Scope is limited to prose in `docs/src/**`; no behavior, settings, or
code changes. 33 files updated, 49 lines changed.
Representative fixes:
- `globs.md`: "features varies" -> "features"; "platforms libc" ->
"platform's libc".
- `installation.md`: "the follow macOS releases" -> "the following macOS
releases".
- `key-bindings.md`: "command pallets" -> "command palette's".
- `linux.md`: capitalization after a period; "able to the environment
variable" -> "able to set the environment variable"; "These feature also
requires" -> "This feature also requires".
- `multibuffers.md`: "Window/Linux" -> "Windows/Linux"; added a missing
closing parenthesis.
- `reference/all-settings.md`: several agreement/article/missing-word
fixes plus an unclosed parenthesis.
- `languages/*`: "partent" -> "parent", "complimentary" ->
"complementary", "setup" -> "set up", "is enabled" -> "are enabled", and
similar.
Release Notes:
- N/A
2026-05-31 22:05:41 +00:00
Ben Kunkle and Zed Zippy
f3a89766b8
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
9168df6260
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
Ben Kunkle
0a437d9908
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
Danilo Leal
0de3d6948a
docs: Fix casing on mentions to some brand names ( #37822 )
...
- MacOS → macOS
- VSCode → VS Code
- SublimeText → Sublime Text
- Javascript/Typescript → JavaScript/TypeScript
Release Notes:
- N/A
2025-09-09 01:45:55 -03:00
d05cd6e2a7
ci: Check for broken links ( #30844 )
...
This PR fixes some broken links that where found using
[lychee](https://github.com/lycheeverse/lychee/ ) as discussed today with
@JosephTLyons and @nathansobo at the RustNL hackathon. Using
[lychee-action](https://github.com/lycheeverse/lychee-action/ ) we can
scan for broken links daily to prevent issues in the future.
There are still 6 broken links that I didn't know how to fix myself.
See https://github.com/thomas-zahner/zed/actions/runs/15075808232 for
details.
## Missing images
```
Errors in ./docs/src/channels.md
[ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-3.png | Cannot find file
[ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-1.png | Cannot find file
[ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-2.png | Cannot find file
```
These errors are showing up as missing images on
https://zed.dev/docs/channels
I tried to search the git history to see when or why they were deleted
but didn't find anything.
## ./crates/assistant_tools/src/edit_agent/evals/fixtures/zode/prompt.md
There are three errors in that file. I don't fully understand how these
issues were caused historically. Technically it would be possible to
ignore the files but of course if possible we should address the issues.
Release Notes:
- N/A
---------
Co-authored-by: Marshall Bowers <git@maxdeviant.com >
Co-authored-by: Ben Kunkle <ben@zed.dev >
2025-06-06 09:39:35 +00:00
Peter Tripp
1cb38f1e4f
docs: Improve LuaLS formatter example ( #32084 )
...
- Closes https://github.com/zed-extensions/lua/issues/4
Release Notes:
- N/A
2025-06-04 11:51:53 -04:00
Peter Tripp
92a38935c0
docs: Improve Lua language documentation ( #28662 )
...
Release Notes:
- N/A
2025-04-13 14:15:57 -04:00
Marshall Bowers
444eaa828f
lua: Extract to zed-extensions/lua repository ( #26250 )
...
This PR extracts the Lua extension to the
[zed-extensions/lua](https://github.com/zed-extensions/lua ) repository.
Release Notes:
- N/A
2025-03-06 23:17:34 +00:00
Marshall Bowers
f84779a483
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
Peter Tripp
4b788e74c5
docs: Improve StyLua Lua formatter suggested settings ( #24144 )
2025-02-10 22:12:01 -05:00
Michael Sloan
eeed071c6d
Use prettier to fix formatting in docs/src/languages/lua.md + fix typo ( #24118 )
...
Release Notes:
- N/A
2025-02-03 04:58:33 +00:00
Billy and Danilo Leal
ea39995ac0
docs: Update completion keybindings and fix typos ( #24113 )
...
Release Notes:
- N/A
---------
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com >
2025-02-03 04:06:07 +00:00
Peter Tripp
f3173a06f4
docs: Add lua-language-server formatter example ( #24105 )
2025-02-02 20:15:50 +00:00
Peter Tripp
c14af317c2
docs: Add Lua formatters section (stylua) ( #24101 )
2025-02-02 18:56:44 +00:00
+4
d4bbb9d30d
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
9d85abb36e
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
78d03f7128
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
Miguel Raz Guzmán Macedo