yenru0/zed
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
35,675 Commits 5 Branches 0 Tags
1fac14fcc7cedcaba4afaa7ca65c0fbb50dedfd3
Commit Graph
34 Commits
Author SHA1 Message Date
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
José DuarteandFinn Evers e913b0e61f docs: Add theme ID suffix recommendation (#48679) 
Added note about suffixing theme IDs with '-theme' for clarity.

As discussed in
https://github.com/zed-industries/extensions/pull/4693#pullrequestreview-3751636461

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

Release Notes:

- Clarified theme ID suffixing in extension docs

---------

Co-authored-by: Finn Evers <finn.evers@outlook.de>
 2026-02-09 08:35:13 +00:00
Finn Evers e2943a78ae docs: Add BSD 2-Clause as accepted extension license (#48363) 
Release Notes:

- N/A
 2026-02-04 13:52:35 +00:00
Finn Evers 0ae0fed2d6 docs: Add LGPL v3 and zlib as accepted extension licenses (#46242) 
Follow-up to https://github.com/zed-industries/extensions/pull/4397

Release Notes:

- N/A
 2026-01-07 10:34:10 +00:00
Finn Evers 268d5f7a70 docs: Improve documentation for updating an extension (#44475) 
Release Notes:

- N/A
 2025-12-09 11:49:33 +00:00
Arun Chapagain 0b5cd0fdfa docs: Update developing extension docs for updating specific submodule (#42548) 
Release Notes:

- N/A
 2025-11-20 13:33:13 +01:00
Marshall Bowers e598d6959a docs: Update extension features language (#42215) 
This PR updates the language around what features extensions can
provide.

Release Notes:

- N/A
 2025-11-07 17:43:22 +00:00
Joseph T. Lyons 97963f5460 Update extension docs to mention BSD 3-Clause is a valid license (#40934) 
Release Notes:

- N/A
 2025-10-22 20:34:38 +00:00
Joseph T. Lyons ee16545016 Update extension docs to mention GNU GPLv3 is a valid license (#40933) 
Merge after: 

- https://github.com/zed-industries/extensions/pull/3641

Release Notes:

- N/A
 2025-10-22 15:59:39 -04:00
Finn Evers ca469c9c81 docs: Update section about installing extensions locally (#40636) 
Release Notes:

- N/A
 2025-10-19 14:30:01 +00:00
Shoghy Martinez 7b43926ff9 docs: Fix grammar in sentence about overridden dev extension (#39968) 
Added missing comma after "After installing" and removed duplicated
"that" in developing-extensions.md.

Release Notes:

- N/A
 2025-10-10 19:21:18 +02:00
Joseph T. Lyons 7876f894a2 Clarify extension license detection in docs (#39456) 
Release Notes:

- N/A
 2025-10-03 12:32:24 +00:00
Joseph T. Lyons c270c86d44 Add extension licensing documentation (#39373) 
Release Notes:

- N/A
 2025-10-02 14:43:19 +00:00
Phileas LebadaandPeter Tripp 0ec071b869 Improve extension development docs (#33646) 
I'm installing an extension for the first time from source and assumed
that the sentence

> If you already have a published extension with the same name
installed, your dev extension will override it.

also means that it would override the already installed extension.

Besides that I've had to use `--foreground` mode to also get more
meaningful error messages under NixOS without using
`programs.nix-ld.enabled = true;`.


Release Notes:

- Improved Zed documentation for extension development

---------

Co-authored-by: Peter Tripp <peter@zed.dev>
 2025-08-08 21:44:03 +00:00
Marshall Bowers 49d7e98c14 docs: Add note about extension submodules needing to use HTTPS URLS (#33454) 
This PR adds a note to the extension publishing docs about extension
submodules needing to use HTTPS URLs.

Release Notes:

- N/A
 2025-06-26 14:18:56 +00:00
Piotr Osiewicz 071a075bf0 docs: Update manifest keys in debugger extension docs (#33085) 
This is silly and caused at least one of our users a lot of confusion.

Closes #33040

Release Notes:

- N/A
 2025-06-20 15:25:53 +02:00
Joseph T. LyonsandPeter Tripp 6df15d66d0 Add docs for cloning extensions repository (#32897) 
Release Notes:

- N/A

---------

Co-authored-by: Peter Tripp <peter@zed.dev>
 2025-06-17 16:31:39 -04:00
Piotr Osiewicz 5c84cda16c extensions: Yet another PR for debugger touchups (#32822) 
We'll now clean up DAP locators for unloaded extensions and load schemas
proper

I can now load a custom Ruby extensions with all bells and whistles and
use it as my debugger.

Release Notes:

- N/A
 2025-06-17 07:34:55 +00:00
Danilo Leal 6c6bc030c0 docs: Improve MCP-related pages (#32422) 
While creating a new MCP extension this weekend, I visited these pages
and it felt like they could be improved a little bit. I'm renaming the
MCP-related page under the /extension directory to use the "MCP"
acronym, instead of "context servers".

Release Notes:

- N/A
 2025-06-09 21:00:10 -03:00
Jens Krause 207c5e4ba4 docs: Suggest checking zed_extension_api compatibility (#30474) 
Or your extension might not work as expected. Or you have to downgrade
`zed_extension_api` later. Happened
[here](https://github.com/sectore/zed-just-ls/issues/2) or
[here](https://github.com/zed-extensions/ruby/commit/842b0cdb6995e692552645c0584ecc9991c589b1)
recently.

Release Notes:

- N/A
 2025-05-10 17:07:00 -04:00
Marshall Bowers 031159ef6d docs: Add note about path in extensions.toml (#25778) 
This PR adds a note about the `path` field in `extensions.toml` and how
to use it.

Suggested in https://github.com/zed-industries/extensions/pull/2128.

Release Notes:

- N/A
 2025-02-27 21:47:01 +00:00
Wilhelm Klopp 8ae61e5d58 docs: Emphasize that Rust must be installed via rustup (#24447) 
Just tried installing a dev extension and kept getting "error: failed to install dev extension".

Turns out this was because I had rust installed via homebrew and not rust. Once I switched to rustup, it worked perfectly fine.

Release Notes:

- N/A
 2025-02-07 11:29:45 -05:00
Peter Tripp e7f3a34fea Update extension extraction docs (#24079) 
- Fixed a regex for finding tags.
- Templatize the instructions with `$LANGNAME` to prevent manual errors
from failing to edit commands (this bit me)
- Ran formatting through Prettier
 2025-02-06 19:01:32 -05:00
Marshall Bowers 54d5bdeb00 docs: Add docs for icon theme extensions (#24155) 
This PR adds docs for icon themes.

Release Notes:

- N/A
 2025-02-04 00:23:33 +00:00
Peter Tripp ce241d2e5b docs: Move install rustup callup to top of developing-extensions.md (#21239) 2024-11-27 09:25:43 -05:00
Marshall Bowers 9d74e2019a docs: Document context servers (#21170) 
This PR adds documentation for context servers.

Release Notes:

- N/A
 2024-11-25 11:05:14 -05:00
Bret Comnes 779f875862 Clarify rustup is requried (#20642) 
Clarify that rustup is required to build developer extensions. Developer
extensions fail silently to the logs because rustup isn't found, even
when rust is installed.

Release Notes:

- N/A
 2024-11-13 17:20:20 -08:00
Chris Boette 6320cb6e4c docs: Note the need for Rust when developing extensions (#18753) 2024-10-05 12:26:28 -04:00
Marshall Bowers 4d65ba6846 docs: Add note about forking the extensions repo to a personal GitHub account (#18631) 
This PR adds a note to the docs encouraging folks to fork the
`zed-industries/extensions` repo to a personal GitHub account rather
than a GitHub organization, as this makes life easier for everyone.

Release Notes:

- N/A
 2024-10-02 10:10:53 -04:00
Marshall Bowers 81d118c429 docs: Add section on updating extensions (#17000) 
This PR adds a section to the extension docs on how to update an
extension.

Moving this over from the docs that used to live in the extensions repo
so that we can have them all in one place.

Release Notes:

- N/A
 2024-08-28 08:57:11 -04:00
Marshall Bowers f65e89c706 docs: Reference latest version of zed_extension_api (#16954) 
This PR updates the extension docs to reference the latest version of
the `zed_extension_api`.

Release Notes:

- N/A
 2024-08-27 11:26:13 -04:00
Danny Hua c6bfeb0e38 docs: Fix example extension directory structure (#16424) 
Add language-specific subdirectory in example directory structure, since
that's the requisite structure - see `extensions/languages.md`

Release Notes:

- N/A
 2024-08-18 07:40:08 -04:00
Marshall Bowers ec9ba06ff8 docs: Add docs for defining slash commands in extensions (#16303) 
This PR adds docs for defining slash commands within extensions.

Release Notes:

- N/A
 2024-08-15 12:50:30 -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