yenru0/zed
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
35,529 Commits 5 Branches 0 Tags
fac9bbd7518d77be2b153a32d0a6dad739345b95
Commit Graph
33 Commits
Author SHA1 Message Date
Ben KunkleandZed Zippy f3a89766b8 Fix docs validation to detect unknown keys (#49660) 
Closes #ISSUE

Release Notes:

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

---------

Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com>
 2026-02-19 20:46:21 -05:00
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
Xin ZhaoandKunall Banerjee 33e0666a00 docs: Update the formatting section for Python (#48904) 
I have added the `code_actions_on_format` setting. I also temporarily
removed the mention of `"formatter": null`. Based on our findings in
#48600, its current behavior is inconsistent, so I've omitted it for now
to avoid confusing users. I will add it back once the underlying issue
is fixed (likely in a subsequent PR).

Closes #48600.

- [ ] Tests or screenshots needed?
- [x] Code Reviewed
- [x] Manual QA

Release Notes:

- N/A

---------

Co-authored-by: Kunall Banerjee <hey@kimchiii.space>
 2026-02-11 08:33:41 +00:00
morgankreyandClaude Opus 4.5 7b95995e6f docs: Apply brand voice standards to AI documentation (#48401) 
## Summary

Reviewed and updated all 18 files in `docs/src/ai/` to meet Zed's brand
voice standards. Each file was scored against the 8-criterion rubric and
rewritten where needed to achieve 4+ on all criteria.

**Changes include:**
- Remove "Learn how to/about" patterns (8 instances)
- Replace vague phrases ("various types of tasks", "and more") with
specific examples
- Remove taboo words ("seamless", "naturally extends")
- Remove emotional language ("We're excited/thrilled/happy")
- Remove marketing patterns ("Stay tuned!", exclamation points)
- Remove unverifiable claims ("world's fastest")
- Replace hedging with direct statements
- Remove promotional emphasis (`_free_`, `**_for free_**`)
- Fix typo in external-agents.md ("servers" → "serves")
- Fix broken link syntax for Ollama Turbo

## Test plan

- [x] `mdbook build` succeeds
- [x] Grep for remaining taboo phrases (only one "seamless" in MCP
official quote, preserved intentionally)
- [x] All facts preserved (URLs, keybindings, settings keys, prices,
model names)

Fixes AI-8

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
 2026-02-04 14:11:55 -08:00
Katie GeerMarshall BowersZed Zippy
 		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
Rob Hand 6759a63105 docs: Update casing of Ty to ty (#45622) 
### Why?

Small nit I noticed when configuring `ty` from Zed docs, ty should
always be stylized as lowercase.

See:
https://github.com/astral-sh/ty?tab=readme-ov-file#how-should-i-stylize-ty

Release Notes:

- N/A
 2026-01-02 01:06:15 -05:00
Jeff BrennanandPiotr Osiewicz 81d5e07743 python: Add SQL syntax highlighting (#43756) 
Release Notes: 

- Added support for SQL syntax highlighting in Python files

## Summary

I am a data engineer who spends a lot of time writing SQL in Python
files using Zed. This PR adds support for SQL syntax highlighting with
common libraries (like pyspark, polars, pandas) and string variables
(prefixed with a `# sql` comment). I referenced
[#37605](https://github.com/zed-industries/zed/pull/37605) for this
implementation to keep the comment prefix consistent.

## Examples
<img width="738" height="990" alt="image"
src="https://github.com/user-attachments/assets/48a859da-c477-490d-be73-ca70d8e47cc9"
/>

---------

Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
 2025-12-15 17:11:07 +01:00
CnsMaple b212909754 docs: Update basedpyright settings examples (#42497) 
The
[example](https://docs.basedpyright.com/latest/configuration/language-server-settings/#zed)
on the official website of basedpyright is correct.

Release Notes:

- Update basedpyright settings examples
 2025-11-12 10:05:17 +01: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
Finn Evers b63e9d1c33 docs: Update basedpyright section (#40079) 
Follows up the report #39794

Release Notes:

- N/A
 2025-10-13 07:21:33 +00: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
Matheus c7536a7790 Docs: change format_on_save value from false to "off" (#38615) 
Found this outdated piece of information in the docs while trying to
disable it myself, this PR simply changes `false` to `"off"`.

Release Notes:

- N/A
 2025-09-22 10:14:04 +00:00
Jaeyong SungandMarshall Bowers a4d95cff35 docs: Fix typo in Python configuration example (#38434) 
Release Notes:

- N/A

---------

Co-authored-by: Marshall Bowers <git@maxdeviant.com>
 2025-09-18 18:46:26 +00:00
Cole MillerKatie GeerPiotr
 		170e814440 Start working on refreshing Python docs (#37880) 
- Reflect that basedpyright is the new primary language server
- Discuss Ruff
- Deemphasize manual venv configuration for language servers

Release Notes:

- N/A

---------

Co-authored-by: Katie Geer <katie@zed.dev>
Co-authored-by: Piotr <piotr@zed.dev>
 2025-09-18 08:53:30 -04: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
Smit Barmase 026b4502a0 Fix tree sitter python try statement to accept missing else/except/finally (#33431) 
We have fork now:
https://github.com/zed-industries/tree-sitter-python/commit/218fcbf3fda3d029225f3dec005cb497d111b35e

Release Notes:

- N/A
 2025-06-26 09:48:44 +05:30
Noritada Kobayashi b9b47b6b73 docs: Fix a broken link to the PyRight Settings section (#29283) 
This PR fixes a broken link to the PyRight Settings section.
This is a follow-up to 9671073215.

Release Notes:

- N/A
 2025-05-05 18:02:53 -04:00
Peter Tripp 9671073215 Initial PyLSP documentation (#26835) 
Closes https://github.com/zed-industries/zed/issues/26820

Release Notes:

- N/A
 2025-03-15 11:03:35 -04: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
Marshall Bowers 6a27aa0037 docs: Use relative Markdown links (#17449) 
This PR updates some links in the docs to use relative Markdown links
instead of absolute links.

This way the links work when running the docs locally.

Release Notes:

- N/A
 2024-09-05 15:31:03 -04:00
Peter Tripp a5b4ac899e docs: Add terminal.detect_venv; only detect venv with bin subdir (#17437) 
- Add docs for terminal.detect_venv
- Only detect venv with bin subdir
 2024-09-05 14:37:13 -04:00
+4
Peter TrippRaunak RajThorsten BallBennetMarshall BowersJoseph T LyonsMikaylaJasonAntonio ScandurraMax BrunsfeldMarshallNathan SoboJason MancusoPiotr Osiewicz
 		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
Vladimir Kukushkin 76c54eb77b docs: Fix Ruff-related links (#15511) 
Release Notes:

- N/A
 2024-08-02 10:16:13 -04:00
YeonGyu-Kim 9e66da6868 Add instructions for configuring linting in the Python documentation using Ruff extension (#14896) 
Added documentation for #14198

I also suggest replacing format guides from `black` to `ruff` to unify
the tooling in the document.

Ruff is now widely used in the Python community, including
[fastapi](https://github.com/tiangolo/fastapi/blob/cd6e9db0653eabbf0fb14908c73939a11a131058/pyproject.toml#L213).
It's compatible with black but a lot faster.

Release Notes:

- N/A
 2024-07-22 11:59:42 +02:00
FilipeBisinella cb343a9796 Add pyright workspace configuration (#14265) 
Release Notes:

- Added support for pyright workspace configuration, as described in
https://microsoft.github.io/pyright/#/settings .
 2024-07-12 15:13:09 -07:00
Zhangfan aff56d0421 docs: Update the example to set up black formatter in Python (#13839) 
As titled. The new example is consistent with the instructions in
"Configuring Zed". I verified that the example works as expected.

Release Notes:

- Update the instructions to set up external formatter for Python.
 2024-07-05 15:32:48 +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
Vitaly Slobodin 190fd85dd7 docs: Fix path to "configuring-zed" page in Python lang doc (#12233) 
Fix path to the `configuring-zed` page in Python language documentation.

Release Notes:

- N/A
 2024-05-24 10:31:32 -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
Joseph T. Lyons 0f2bf0201c Document configuring pyright for pyproject.toml (#11508) 
Release Notes:

- N/A
 2024-05-07 14:40:34 -04:00
Adrian Garcia Badaracco c754875399 Fix link in python.md (#7735) 2024-02-14 10:30:30 -08:00
Marshall Bowers 470be88e11 Adjust heading levels in docs (#7163) 
This PR adjusts the heading levels in the docs, as some of them weren't
following the right hierarchy.

I also formatted all of the docs with Prettier.

Release Notes:

- N/A
 2024-01-31 12:34:31 -05: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