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
Karl-Erik Enkelmann
17933f1222
Update documentation on Java support ( #41758 )
...
This brings the documentation on Java in line with the much changed
reality of the Java extension.
Note that the correctness of this is contingent on
https://github.com/zed-industries/extensions/pull/3745 being merged.
Release Notes:
- N/A
2025-11-05 12:24:29 +01: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
Danilo Leal
3e605c2c4b
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
Peter Tripp
440beb8a90
Improve Java LSP documentation ( #34410 )
...
Remove references to
[ABckh/zed-java-eclipse-jdtls](https://github.com/ABckh/zed-java-eclipse-jdtls )
which hasn't seen a new version in 10 months (2024-10-01).
Release Notes:
- N/A
2025-07-14 18:16:43 -04: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
peanut996
51f07e3382
docs: Update Java extension config example ( #23885 )
2025-01-30 13:40:51 +00:00
Valentine Briese
be474a6d6f
docs: Update info on JDTLS install for Java ( #19436 )
2024-10-18 17:12:34 -04:00
Valentine Briese
6a463be1ae
docs: Direct Java extension users to JDTLS initialization options ( #19401 )
...
Continuation of #19390
2024-10-18 15:02:42 -04:00
Peter Tripp
5168fc27a1
docs: More Java extension documentation ( #19390 )
...
Follow up of: https://github.com/zed-industries/zed/pull/19113
2024-10-17 20:21:45 -04:00
Heavysnowjakarta
f9d4272e13
docs: Java extension settings ( #19113 )
...
Co-authored-by: Peter Tripp <peter@zed.dev>
2024-10-17 00:04:59 -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
