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
mg and Kirill Bulatov
f4b37f571d
Add Windows path for extensions ( #42645 )
...
### Description
The `installing-extensions.md` guide was missing the directory path for
the Windows platform. It currently only lists the paths for macOS and
Linux. This PR adds the correct path for Windows users
(`%LOCALAPPDATA%\zed\extensions`).
Release Notes:
- N/A
---------
Co-authored-by: Kirill Bulatov <mail4score@gmail.com >
2025-11-24 09:46:15 +00:00
Peter Tripp
b5515b615e
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
Tom Zaspel and Peter Tripp
47cafe8b35
docs: Add documentation for auto_install_extensions setting ( #19559 )
...
Improved: Documenation for (un)installing extensions automatically.
Signed-off-by: Tom Zaspel <tom@zaspel.it >
Co-authored-by: Peter Tripp <peter@zed.dev >
2024-10-23 11:57:13 -04:00
Marshall Bowers
ec4f60a7e3
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
+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
morgankrey