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
1810ca0290
docs: Big reorganize ( #45276 )
...
Release Notes:
- N/A
Overview
Restructures the documentation navigation to be organized by user goals
rather than feature lists. Introduces a new "Working with Code" section
and reorganizes existing content into clearer groupings.
### Navigation Changes
**New top-level sections:**
- **Working with Code** — Groups editing, navigation, and execution
features by workflow
- **Reference** — Dedicated section for lookup-only content (settings,
actions, CLI)
- **Coming From...** — Migration guides grouped together
**Reorganized sections:**
- **Customization** — Renamed from "Configuration," focused on
appearance and keybindings
- **Account & Privacy** — Consolidated auth, privacy, and telemetry
pages
New Files
| File | Purpose |
|------|---------|
| `editing-code.md` | Overview page for editing features |
| `finding-navigating.md` | Overview page for navigation tools with
quick reference |
| `running-testing.md` | Overview page for tasks, debugger, and REPL |
| `reference/all-settings.md` | Settings reference (moved/renamed) |
| `reference/cli.md` | CLI reference (moved) |
### Content Moves
| Page | From | To |
|------|------|-----|
| Snippets | Customization | Working with Code → Editing Code |
| Code Completions | (flat) | Working with Code → Editing Code |
| Diagnostics | (flat) | Working with Code → Editing Code |
| Multibuffers | (flat) | Working with Code → Editing Code |
| Command Palette | (flat) | Working with Code → Finding & Navigating |
| Outline Panel | (flat) | Working with Code → Finding & Navigating |
| Tab Switcher | (flat) | Working with Code → Finding & Navigating |
| Tasks | (flat) | Working with Code → Running & Testing |
| Debugger | (flat) | Working with Code → Running & Testing |
| REPL | (flat) | Working with Code → Running & Testing |
| All Settings | Configuration | Reference |
| CLI | (various) | Reference
---------
Co-authored-by: Marshall Bowers <git@maxdeviant.com >
Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com>
2026-01-20 13:04:27 -08:00
André Eriksson and Danilo Leal
f9823eb6bd
docs: Add Tailwind configuration section for JavaScript/TypeScript ( #45057 )
...
Addresses some tasks in #43969 . Namely adding TailwindCSS documentation
for the following languages: HTML, JavaScript and Typescript.
**Some Notes**
- Maybe the additional information in the HTML section is unnecessary,
unsure open to suggestions.
- I tried utilizing capturing groups with alternatives like
`\\.(add|remove|toggle|contains)` but this didn't seem to work, so I was
forced to use multiple lines.
Release Notes:
- N/A
---------
Co-authored-by: Danilo Leal <daniloleal09@gmail.com >
2025-12-17 14:16:37 +00:00
Liffindra Angga Zaaldian
07837c6fa4
Update JavaScript default language server ( #43316 )
...
As stated in [TypeScript Language Server
documentation](https://zed.dev/docs/languages/typescript#language-servers ),
JavaScript uses `vtsls` as the default language server.
Release Notes:
- N/A
2025-11-22 12:21:56 +02:00
Angelo Verlain and Ben Kunkle
5fe04e6793
docs: Update docs for using ESLint as the only formatter ( #40679 )
...
Closes #ISSUE
Release Notes:
- N/A
---------
Co-authored-by: Ben Kunkle <Ben.kunkle@gmail.com >
2025-10-29 13:58:35 +00:00
Kunall Banerjee
860b2b05a6
docs: Fix small grammatical typo in JSX section ( #41055 )
...
Happened to notice this typo while going through the docs.
Release Notes:
- N/A
---
💖
2025-10-24 00:38:32 +02:00
Mikayla Maki
55b09afcef
docs: Improve debug adapter documentation ( #40441 )
...
docs. docs. docs.
Release Notes:
- N/A
2025-10-17 00:36:47 +00:00
f5a4555a3d
Revert deprecate code actions on format ( #40409 )
...
Closes #40334
This reverts the change made in #39983 , and includes a replacement
migration that will transform formatter settings values consisting of
only `code_action` format steps into the previously deprecated
`code_actions_on_format` in an attempt to restore the behavior to what
it was before the migration that deprecated `code_actions_on_format`.
This PR will result in a modified order in the `code_actions_on_format`
setting if it existed, however the decision was made to explicitly
ignore this for now, as this PR is primarily targeting users who have
already had the deprecation migration run, and no longer have the
`code_actions_on_format` key
Release Notes:
- Fixed an issue with a settings migration that deprecated the
`code_actions_on_format` setting. The `code_actions_on_format` setting
has been un-deprecated, and affected users will have the bad migration
rolled back with an updated migration
---------
Co-authored-by: Cole Miller <cole@zed.dev >
Co-authored-by: Mikayla Maki <mikayla.c.maki@gmail.com >
Co-authored-by: HactarCE <6060305+HactarCE@users.noreply.github.com >
2025-10-16 14:11:20 -04:00
versecafe
83297a0745
typescript: Runners support for bun:test & node:test ( #39238 )
...
Closes #21132
Release Notes:
- JavaScript/TypeScript: Added support for detecting `node:test` and `bun:test` test runners
2025-10-13 09:05:04 +02: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
Ben Kunkle
7a2c99a5a3
docs: Remove/fix mentions of code_actions_on_format post #39983 ( #40040 )
...
Closes #ISSUE
Release Notes:
- N/A *or* Added/Fixed/Improved ...
2025-10-11 23:55:57 +00:00
Cole Miller
f930cf5882
Move language-specific debugging docs to the page for each language ( #33692 )
...
Release Notes:
- N/A
2025-07-01 20:02:12 +00:00
Danilo Leal
c7cce5a256
docs: Add small refinements to CSS adjacent pages ( #31683 )
...
Follow up to https://github.com/zed-industries/zed/pull/31681 . Was
visiting some of these pages and noticed these somewhat small formatting
and copywriting improvement opportunities. The docs for Svelte in
particular felt somewhat unorganized.
Release Notes:
- N/A
2025-05-29 08:43:54 -03:00
Danilo Leal
c58cd1df73
docs: Improve the Tailwind CSS page ( #31681 )
...
Namely, ensuring we mention the support for their Prettier plugins.
Release Notes:
- N/A
2025-05-29 08:15:59 -03: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
Thorsten Ball
0ba8eac690
eslint: Allow configuring workingDirectory ( #22972 )
...
This addresses this comment here:
https://github.com/zed-industries/zed/issues/9648#issuecomment-2579246865
Release Notes:
- Added ability to configure `workingDirectory` when using ESLint.
Example: `{"lsp": {"eslint": {"settings": {"workingDirectory": {"mode":
"auto" }}}}}`
2025-01-10 22:21:51 +00:00
Thorsten Ball
85de2405d2
docs: Update JavaScript docs and remove TBDs ( #17989 )
...
Release Notes:
- N/A
2024-09-20 08:04:26 +02:00
Mikayla Maki
fde7414f52
Remove visible 'TBD' from docs ( #17979 )
...
Release Notes:
- N/A
2024-09-17 15:39:44 -07:00
Henrikh Kantuni
861ebba3b0
Fix typo ( #16657 )
...
`format_on_save` → `formatter`
Release Notes:
- N/A
2024-08-22 14:02:41 +03: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
aeb02989d0
docs: Format docs ( #15352 )
...
This PR formats the rest of the docs' source files.
I'll follow up with a CI check to ensure they stay formatted.
Release Notes:
- N/A
2024-07-27 14:52:21 -04:00
Piotr Osiewicz and Saurabh
4b07805f71
Add support for projects managed with Yarn ( #13644 )
...
TODO:
- [ ] File a PR with Yarn to add Zed to the list of supported IDEs.
Fixes: https://github.com/zed-industries/zed/issues/10107
Fixes: https://github.com/zed-industries/zed/issues/13706
Release Notes:
- Improved experience in projects using Yarn. Run `yarn dlx
@yarnpkg/sdks base` in the root of your project in order to elevate your
experience.
---------
Co-authored-by: Saurabh <79586784+m4saurabh@users.noreply.github.com >
2024-07-11 14:56:07 +02:00
Marshall Bowers
c6408ae098
docs: Update language pages to indicate whether they are native or from an extension ( #13827 )
...
This PR updates the language pages in the docs to indicate whether the
support is available natively or provided by an extension.
Release Notes:
- N/A
2024-07-04 10:40:21 -04:00
Marshall Bowers
b75d4abae3
docs: Remove references to language_overrides ( #12169 )
...
This PR replaces references to `language_overrides` in the docs with
just `languages`.
`language_overrides` is an alias for `languages`, and we want to move
towards just using `languages`.
Release Notes:
- N/A
2024-05-22 18:37:24 -04:00
Danilo Leal
238232c392
docs: Standardize "Note" blockquote usage ( #11724 )
...
Standardize the blockquote "Notes" usage, so all places are using the
`>` blockquote notation, as well as a consistent style for the "Note"
word.
PS: Thought that bolding the word "**Note**" would make for a higher
visual distinction, so went for it in all existing cases! No strong
feelings, though; happy to roll back to just "Note:" if that's
preferrable!
Release Notes:
- N/A
2024-05-13 09:02:44 -04:00
Gu
ec68947745
docs: Fix broken link ( #11685 )
...
configuration link in `javascript.md`
https://zed.dev/docs/languages/javascript
Release Notes:
- N/A
2024-05-12 23:06:48 -04:00
William Villeneuve
3a2b1caf03
Allow users to configure ESLint's rulesCustomizations settings ( #11135 )
...
https://github.com/zed-industries/zed/assets/2072378/18f0bb28-0546-4234-a11f-39af6c9fcc12
`rulesCustomizations` is an array of rule severity overrides. Globs can
be used to apply default severities for multiple rules. See
[docs](https://github.com/microsoft/vscode-eslint/blob/553e632fb4cf073fce1549fb6c3c1b5140a52ebb/README.md?plain=1#L312-L333 )
& [type
definitions](https://github.com/microsoft/vscode-eslint/blob/553e632fb4cf073fce1549fb6c3c1b5140a52ebb/%24shared/settings.ts#L168 )
Example Zed `settings.json` to override all eslint errors to warnings:
```jsonc
{
"lsp": {
"eslint": {
"settings": {
"rulesCustomizations": [
// set all eslint errors/warnings to show as warnings
{ "rule": "*", "severity": "warn" }
]
}
}
}
}
```
Release Notes:
- Added support for configuring ESLint's `rulesCustomizations` settings,
ie. `{"lsp": {"eslint": {"settings": {"rulesCustomizations": [{"rule":
"*", "severity": "warn"}]}}}}`
2024-04-29 11:41:48 +03:00
Thorsten Ball
d2f778aa34
Document formatter: code_actions ( #10157 )
...
This documents what was introduced in #10121 and shipped in 0.130.x
Release Notes:
- N/A
2024-04-04 14:12:28 +02:00
Thorsten Ball
285bc64eed
docs: minor changes to ESLint docs ( #10116 )
...
We allow more than just `shortenToSingleLine`, so let's document the
whole thing.
Release Notes:
- N/A
2024-04-03 14:07:23 +02:00
William Villeneuve
bb40d9f367
Allow users to configure ESLint's problems settings ( #9981 )
...
Presently the only available setting under `problems` is
`shortenToSingleLine`, which defaults to `false`.
Example Zed `settings.json` to shorten eslint error squiggles to only
show on the first line of the problem:
```json
{
"lsp": {
"eslint": {
"settings": {
"problems": {
"shortenToSingleLine": true
}
}
}
}
}
```
Release Notes:
- Added support for configuring ESLint `problems` settings, ie. `{"lsp":
{"eslint": {"settings": {"problems": {"shortenToSingleLine": true}}}}}`
Demo:
https://github.com/zed-industries/zed/assets/2072378/379faa75-1f37-4fd1-85da-1510f1397d07
2024-04-03 09:29:07 +02:00
Thorsten Ball
48ed3351f6
Revert "Add working directories for eslint ( #9738 )" ( #9914 )
...
This reverts commit b12c533eb5https://github.com/zed-industries/zed/pull/9738 since it doesn't seem to
do anything. See:
https://github.com/zed-industries/zed/issues/9648#issuecomment-2025132087
Release Notes:
- N/A
2024-03-28 15:09:05 +01:00
Hans and Thorsten Ball
b12c533eb5
Add working directories for eslint ( #9738 )
...
Fix #9648
Release notes:
- Added ability to configure ESLint's `workingDirectories` in settings.
Example:
`{"lsp":{"eslint":{"settings":{"workingDirectories":["./client","./server"]}}}}`.
#9648
---------
Co-authored-by: Thorsten Ball <mrnugget@gmail.com >
2024-03-28 07:01:19 +01:00
Thorsten Ball
6421828cf6
Add ESLint information to JavaScript docs ( #9158 )
...
Release Notes:
- N/A
2024-03-11 10:30:25 +01: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
morgankrey