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 Geer
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
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
Danilo Leal
f68f4ab982
docs: Add tweaks to the REPL page ( #18000 )
...
Just capitalizing some things, making sure URLs are clickable links, and
using the note blockquote callout when appropriate.
Release Notes:
- N/A
2024-09-18 07:34:39 -03:00
Danilo Leal
7180880047
docs: Add design touch-ups ( #17505 )
...
This PR adds several design tweaks to elements of the documentation,
most notably swapping the heading title font from `PPAgrandir` to
`Lora`, which makes the docs consistent with the new website. Aside from
this, there's also some tiny, low-hanging content adjustments to a few
pages.
---
Release Notes:
- N/A
2024-09-06 13:43:54 -03: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
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
Egor Kotov
69cefb3a0c
docs: Add brief R/Ark instructions ( #15357 )
...
Added brief instructions for [`Ark`](https://github.com/posit-dev/ark )
kernel for `R`.
Release Notes:
- N/A
---------
Co-authored-by: Marshall Bowers <elliott.codes@gmail.com >
2024-08-02 10:22:45 -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
Kyle Kelley
13693ff80f
docs: Embed video directly, copying formatting from blog ( #15229 )
...
Quick doc fix for formatting and display.

Release Notes:
- N/A
2024-07-25 16:05:04 -07:00
Kyle Kelley
cc1d3f0a35
docs: Update REPL docs with images, cell mode, and kernel debugging ( #15226 )
...
Just a few doc tweaks.
Release Notes:
- N/A
2024-07-25 14:26:14 -07:00
Kyle Kelley
23dac9cfce
docs: Show how to use the percent format to denote cells for the Zed REPL ( #15099 )
...
Release Notes:
- N/A
2024-07-24 10:31:25 -07:00
Thorsten Ball
7644605f0f
docs: Fix default binding for REPL ( #15065 )
...
Release Notes:
- N/A
2024-07-24 09:50:23 +02:00
Kyle Kelley
53b711c2b4
repl: Make the terminal background transparent ( #15022 )
...
Keeps the background the same as the output area background by making
the terminal background be `Hsla::transparent_black()`.
Release Notes:
- N/A
---------
Co-authored-by: Nathan Sobo <nathan@zed.dev >
Co-authored-by: Antonio Scandurra <me@as-cii.com >
2024-07-23 11:03:22 -07:00
Nathan Sobo
d9a00b6f8b
Update setting name in REPL docs ( #15017 )
...
cc @rgbkrk @iamnbutler
Release Notes:
- N/A
2024-07-23 09:53:46 -07:00
Michael Angerman
ca2976559e
docs: Fix jupyter spelling in the command jupyter kernelspec list ( #14694 )
...
jupyter was spelled wrong in the repl docs
Release Notes:
- N/A
2024-07-17 20:03:04 -04:00
Kyle Kelley
738d079aa7
docs: Remove extra backtick within repl docs ( #14611 )
2024-07-17 06:59:05 -07:00
Kyle Kelley
b3d0ac3e3c
Show how to switch out kernels and discover them ( #14531 )
...
A few new doc changes for the repl feature.
Release Notes:
- N/A
2024-07-16 09:12:50 -07:00
Nate Butler
fa3d29087d
Add REPL dropdown menu to toolbar ( #14493 )
...
TODO:
- [x] Actions run from menu not firing
- [x] Menu differentiates idle and busy for running kernel
Menu States:
- [x] No session && no support known
No session && no kernel installed for languages of known support
- (TODO after) Intro to REPL
- [x] Link to docs
No session but can start one
- [x] Start REPL
- (TODO after) More info -> Docs?
Yes Session
- [x] Info: Kernel name, language
example: chatlab-3.7-adsf87fsa (Python)
example: condapy-3.7 (Python)
- [x] Change Kernel -> https://zed.dev/docs/repl#change-kernel
- ---
- [x] Run
- [x] Interrupt
- [x] Clear Outputs
- ---
- [x] Shutdown
(Release notes left empty as the change will be documented in the REPL
release!)
Reserved for a follow on PR:
```
- [ ] Status should update when the menu is open (missing `cx.notify`?)
- [ ] Shutdown all kernels action
- [ ] Restart action
- [ ] [Default kernel changed - restart (this kernel) to apply] // todo!(kyle): need some kind of state thing that says if this has happened
```
Release Notes:
- N/A
---------
Co-authored-by: Marshall Bowers <elliott.codes@gmail.com >
Co-authored-by: Kyle Kelley <rgbkrk@gmail.com >
Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com >
2024-07-15 11:55:49 -07:00
Kyle Kelley
896b9bda23
Stick REPL icon in quick action bar ( #14064 )
...
REPL Quick Actions
<img width="325" alt="image"
src="https://github.com/zed-industries/zed/assets/836375/faaf4c8f-ef12-4417-a9dd-158d5beae8ba ">
When the Jupyter REPL is enabled and a kernel is available, show the
status in the editor bar:

Release Notes:
- N/A
---------
Co-authored-by: Nate Butler <iamnbutler@gmail.com >
2024-07-10 09:20:52 -07:00