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
Rob Hand
8e825033f8
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 Brennan and Piotr Osiewicz
c20cbba0eb
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
4f158c1983
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
908ae95cf8
docs: Improve debug adapter documentation ( #40441 )
...
docs. docs. docs.
Release Notes:
- N/A
2025-10-17 00:36:47 +00:00
Finn Evers
eeaf0b5fec
docs: Update basedpyright section ( #40079 )
...
Follows up the report #39794
Release Notes:
- N/A
2025-10-13 07:21:33 +00: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
Matheus
79620454d0
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 Sung and Marshall Bowers
6b8ed5bf28
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
82686bf94c
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
b7bfdd3383
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
1753432406
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
0bf682a0d5
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 5f390f1bf8
2025-05-05 18:02:53 -04:00
Peter Tripp
5f390f1bf8
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
3b3c379852
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
e5858c8b91
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
d6ab569e42
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
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
Vladimir Kukushkin
55fbafee35
docs: Fix Ruff-related links ( #15511 )
...
Release Notes:
- N/A
2024-08-02 10:16:13 -04:00
YeonGyu-Kim
a334c69e05
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
21c5ce2bbd
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
1bd585186a
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
e3cd1dd2d0
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
414f97f702
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
2564d5d648
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
953acb0f6d
Document configuring pyright for pyproject.toml ( #11508 )
...
Release Notes:
- N/A
2024-05-07 14:40:34 -04:00
Adrian Garcia Badaracco
a02bdd0a9f
Fix link in python.md ( #7735 )
2024-02-14 10:30:30 -08:00
Marshall Bowers
39200ec9f7
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
6cd306e4c9
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
