yenru0/zed
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
35,579 Commits 5 Branches 0 Tags
8b2829e1122094b6cd3fcce5e016f08cb5741281
Commit Graph
29 Commits
Author SHA1 Message Date
morgankrey 876086e841 docs: Apply preview release suggestions (#50118) 
Documentation updates for Preview release - generated by
docs-suggest-publish

Release Notes:

- N/A
 2026-02-25 15:15:38 -06: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
Katie GeerandClaude Opus 4.6 718dc62dbc docs: Add AI SEO frontmatter (#48559) 
Closes #ISSUE

Release Notes:

- N/A *or* Added/Fixed/Improved ...

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
 2026-02-11 13:10:31 -08:00
Katie GeerMarshall BowersZed Zippy
 		ece66be3df 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
Katie Geer b75736568b docs: Reorganize introduction (#41387) 
Release Notes:
- Remove Windows/Linux from Getting Started
- Consolidate download & system into new Installation page
- Move Remote Dev out of Windows and into Remote Development
- Add Uninstall page
- Add updates page
- Remove addl learning materials from intro
 2025-10-28 17:39:40 -03:00
Danilo Leal db0f7a8b23 docs: Mention the settings and keymap UIs more prominently (#41302) 
Release Notes:

- N/A
 2025-10-27 15:17:11 -03:00
Katie GeerKateJulia RyanMax Brunsfeld
 		6f97d74ff9 Docs windows update (#39501) 
Updating Zed Docs for Windows

---------

Co-authored-by: Kate <work@localcc.cc>
Co-authored-by: Julia Ryan <juliaryan3.14@gmail.com>
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
 2025-10-15 09:27:54 -07:00
Danilo Leal 18405dece8 Rename settings and keymap actions (#39970) 
This PR renames the following actions to make it easier and prioritize
the UI version of interacting with them:

| Before | After |
|--------|--------|
| `OpenSettingsEditor` | `OpenSettings` |
| `OpenSettings` | `OpenSettingsFile` |
| `OpenKeymapEditor` | `OpenKeymap` |
| `OpenKeymap` | `OpenKeymapFile` | 

Release Notes:

- Rename actions to open settings (UI/window and JSON file) as well as
to open the keymap (editor tab and JSON file).
 2025-10-10 17:29:20 -03:00
Peter Tripp 055a9f21a0 Fix keybinds and 'No default binding' shown in docs (#35227) 
Previously:
<img width="724" height="234" alt="Screenshot 2025-07-28 at 14 49 50"
src="https://github.com/user-attachments/assets/b5203316-221d-4af5-8190-124f9b2b4cdf"
/>


Release Notes:

- N/A
 2025-07-28 14:58:43 -04:00
Kirill Bulatov d5472bc0ad Document zed CLI (#32879) 
Closes https://github.com/zed-industries/zed/issues/32646

Release Notes:

- N/A
 2025-06-17 15:53:29 +00:00
Danilo Leal 1b3f20bdf4 docs: Refine a few AI pages (#31381) 
Mostly sharpening the words, simplifying, and removing duplicate
content.

Release Notes:

- N/A
 2025-05-25 11:03:14 -03:00
ZaraPhu 007685f6d4 docs: Add instructions for uninstalling Zed (#29840) 2025-05-04 17:41:36 +00:00
Danilo Leal a6f95a14b7 docs: Improve the Getting Started page (#22545) 
- Little tweaks to wording and punctuation
- Remove redundancy on the Configuration and Key binding sections
- Ensure key bindings for the sections mentioned above appear

Release Notes:

- N/A
 2025-01-01 17:19:10 +00:00
Marshall Bowers b374c7d912 Fix casing of "macOS" (#17040) 
This PR fixes a number of spots in English contexts (docs, comments,
etc.) where we were using "MacOS" instead of "macOS".

Release Notes:

- N/A
 2024-08-28 19:10:49 -04:00
Nate Butler 7a964ff91a Don't rely on relative path for docs preprocessor (#16883) 
Reapplies #16700 with a corrected command. Now it no longer relies on a
relative path.

Thanks @maxdeviant for the quick help 🙏 

Release Notes:

- N/A
 2024-08-26 11:43:13 -04:00
Nate Butler 2a03dde538 Revert "Add docs_preprocessor crate to support Zed Docs" (#16880) 
Temporarily revert #16700 to deal with this error:

`error: manifest path `../crates/docs_preprocessor/Cargo.toml` does not
exist` as it was causing the docs-preprocessor not to run, meaning
unexpanded templates were showing up in the public docs.

Reverts zed-industries/zed#16700

Release Notes:

- N/A
 2024-08-26 11:06:25 -04:00
Nate Butler 46bb04a019 Add docs_preprocessor crate to support Zed Docs (#16700) 
This PR adds a mdbook preprocessor for supporting Zed's docs.

This initial version adds the following custom commands:

**Keybinding** 

`{#kb prefix::action_name}` (e.g. `{#kb zed::OpenSettings}`)

Outputs a keybinding template like `<kbd
class="keybinding">{macos_keybinding}|{linux_keybinding}</kbd>`. This
template is processed on the client side through `mdbook` to show the
correct keybinding for the user's platform.

**Action** 

`{#action prefix::action_name}` (e.g. `{#action zed::OpenSettings}`)

For now, simply outputs the action name in a readable manner. (e.g.
zed::OpenSettings -> zed: open settings)

In the future we'll add additional modes for this template, like create
a standard way to render `{action} ({keybinding})`.

## Example Usage

```
To open the assistant panel, toggle the right dock by using the {#action workspace::ToggleRightDock} action in the command palette or by using the
{#kb workspace::ToggleRightDock} shortcut.
```

Release Notes:

- N/A
 2024-08-26 10:50:40 -04:00
Nate Butler 9951df7709 Update some docs keybindings to new format (#16524) 
Updates some of the docs pages to the new keybinding format.

Release Notes:

- N/A
 2024-08-20 11:23:40 -04:00
+4
Peter TrippRaunak RajThorsten BallBennetMarshall BowersJoseph T LyonsMikaylaJasonAntonio ScandurraMax BrunsfeldMarshallNathan SoboJason MancusoPiotr Osiewicz
 		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 3a44a59f8e 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
BuzzandThorsten Ball cdfadcc582 docs: Introduce command palette earlier (#14467) 
Can't get to many of the settings on linux without opening it, and can't
know the default keystroke to get to it without knowing where to look
first, so its a chicken-n-egg problem of needing to use a
default-keystroke to set the key bindings, esp on linux.


Release Notes:

- N/A

---------

Co-authored-by: Thorsten Ball <mrnugget@gmail.com>
 2024-07-18 14:09:43 +02:00
Justin Su 344e315174 Add -f to curl commands (#14667) 
Release Notes:

- Updated curl commands with `-f` for improved error handling
([#14346](https://github.com/zed-industries/zed/issues/14346)).
 2024-07-17 15:27:32 -06:00
Mikayla Maki 0c1a3db87d Update getting-started.md 2024-07-11 11:50:36 -07:00
Danilo Leal 29226170f1 docs: Add tiny tweaks to the Linux page (#13994) 
Release Notes:

- N/A
 2024-07-09 11:26:22 -03:00
Conrad Irwin 5c95d2806b Ensure people who hit /linux directly have the right instructions (#13959) 
Release Notes:

- N/A
 2024-07-08 21:43:12 -06:00
Conrad IrwinMikayla MakiMarshall Bowers
 		97f315356d Linux docs (#13945) 
Release Notes:

- N/A

---------

Co-authored-by: Mikayla Maki <mikayla@zed.dev>
Co-authored-by: Marshall Bowers <elliott.codes@gmail.com>
 2024-07-08 15:29:28 -07:00
Kirill Bulatov 67c9fc575f Fix a link to Zed configuring docs (#11739) 
Based on https://github.com/zed-industries/zed/pull/11736 

Release Notes:

- N/A
 2024-05-14 17:15:14 -04:00
Danilo Leal 4446c38705 docs: Add link for "Configuring Zed" mention (#11723) 
Release Notes:

- N/A
 2024-05-12 21:57:38 +03:00
Conrad IrwinMarshall BowersMarshall
 		a497c49fb8 update docs content (#11374) 
Move all docs to zed repo

Release Notes:

- N/A

---------

Co-authored-by: Marshall Bowers <elliott.codes@gmail.com>
Co-authored-by: Marshall <marshall@zed.dev>
 2024-05-03 16:24:04 -06:00