diff --git a/docs/src/ai/agent-panel.md b/docs/src/ai/agent-panel.md index e657f6b617..b7d17bba88 100644 --- a/docs/src/ai/agent-panel.md +++ b/docs/src/ai/agent-panel.md @@ -255,7 +255,7 @@ Copying an image and pasting it is also supported. Zed surfaces how many tokens you are consuming for your currently active thread near the profile selector in the panel's message editor. Once you approach the model's context window, a banner appears above the message editor suggesting to start a new thread with the current one summarized and added as context. -You can also do this at any time with an ongoing thread via the "Agent Options" menu on the top right, where you'll see a "New from Summary" button, as well as simply @-mentioning a past thread in a new one.. +You can also do this at any time with an ongoing thread via the "Agent Options" menu on the top right, where you'll see a "New from Summary" button, as well as simply @-mentioning a past thread in a new one. ## Changing Models {#changing-models} diff --git a/docs/src/ai/billing.md b/docs/src/ai/billing.md index d5fc6750e8..eb3a7875e6 100644 --- a/docs/src/ai/billing.md +++ b/docs/src/ai/billing.md @@ -48,7 +48,7 @@ Zed Business consolidates your team's costs. Seat licenses and AI usage for all ### Billing dashboard {#dashboard} -Owners and admins can access billing information at [dashboard.zed.dev](https://dashboard.zed.dev). The dashboard shows the plan you're currently on and offers jumping off points to update billing details, such as the billing name and address, as well as payment information. You can also access your invoices history, accessible through the Orb billing portal. +Owners and admins can access billing information at [dashboard.zed.dev](https://dashboard.zed.dev). The dashboard shows the plan you're currently on and offers jumping off points to update billing details, such as the billing name and address, as well as payment information. You can also access your invoice history, accessible through the Orb billing portal. ### AI usage {#ai-usage} diff --git a/docs/src/ai/edit-prediction.md b/docs/src/ai/edit-prediction.md index 1f5b3e8adc..fda36a39cd 100644 --- a/docs/src/ai/edit-prediction.md +++ b/docs/src/ai/edit-prediction.md @@ -111,7 +111,7 @@ After that, `alt-tab` remains available for accepting edit predictions, and on L To move both default accept bindings to something else, unbind them and add your replacement: -Open the keymap editor with {#action zed::OpenKeymap} ({#kb zed::OpenKeymap}), search for `AcceptEditPrediction`, right click on the binding for `tab` and delete it. Then right click on the binding for `alt-tab`, select "Edit", and record your desired keystrokes before hitting saving. +Open the keymap editor with {#action zed::OpenKeymap} ({#kb zed::OpenKeymap}), search for `AcceptEditPrediction`, right click on the binding for `tab` and delete it. Then right click on the binding for `alt-tab`, select "Edit", and record your desired keystrokes before saving. Alternatively, you can put the following in your `keymap.json`: diff --git a/docs/src/ai/external-agents.md b/docs/src/ai/external-agents.md index dd3f68d5b3..81a4ee5d3d 100644 --- a/docs/src/ai/external-agents.md +++ b/docs/src/ai/external-agents.md @@ -237,7 +237,7 @@ It's also possible to customize environment variables for registry-installed age ## Debugging Agents -When using external agents in Zed, you can access the debug view via with {#action dev::OpenAcpLogs} from the Command Palette. +When using external agents in Zed, you can access the debug view via {#action dev::OpenAcpLogs} from the Command Palette. This lets you see the messages being sent and received between Zed and the agent. ![The debug view for ACP logs.](https://zed.dev/img/acp/acp-logs.webp) diff --git a/docs/src/ai/llm-providers.md b/docs/src/ai/llm-providers.md index 3c08a960da..0c8645648c 100644 --- a/docs/src/ai/llm-providers.md +++ b/docs/src/ai/llm-providers.md @@ -515,7 +515,7 @@ One such service is [Ollama Turbo](https://ollama.com/turbo). To configure Zed t 4. Paste your API key and press enter. 5. For the API URL enter `https://ollama.com` -Zed will also use the `OLLAMA_API_KEY` environment variables if defined. +Zed will also use the `OLLAMA_API_KEY` environment variable if defined. ### OpenAI {#openai} diff --git a/docs/src/ai/mcp.md b/docs/src/ai/mcp.md index 6582508f5c..c3fedb9440 100644 --- a/docs/src/ai/mcp.md +++ b/docs/src/ai/mcp.md @@ -81,7 +81,7 @@ For example, the GitHub MCP extension requires you to add a [Personal Access Tok In the case of custom servers, make sure you check the provider documentation to determine what type of command, arguments, and environment variables need to be added to the JSON. To check if your MCP server is properly configured, go to the Agent Panel's settings view and watch the indicator dot next to its name. -If they're running correctly, the indicator will be green and its tooltip will say "Server is active". +If it's running correctly, the indicator will be green and its tooltip will say "Server is active". If not, other colors and tooltip messages will indicate what is happening. ### Agent Panel Usage @@ -162,7 +162,7 @@ For details on what configuration is shared between Zed and external agents, see ### Error Handling -When a MCP server encounters an error while processing a tool call, the agent receives the error message directly and the operation fails. +When an MCP server encounters an error while processing a tool call, the agent receives the error message directly and the operation fails. Common error scenarios include: - Invalid parameters passed to the tool diff --git a/docs/src/configuring-languages.md b/docs/src/configuring-languages.md index d4e76534fd..5113453a7b 100644 --- a/docs/src/configuring-languages.md +++ b/docs/src/configuring-languages.md @@ -249,7 +249,7 @@ Most of the servers would rely on this way of configuring only. } ``` -Apart of the LSP-related server configuration options, certain servers in Zed allow configuring the way binary is launched by Zed. +Apart from the LSP-related server configuration options, certain servers in Zed allow configuring the way binary is launched by Zed. Language servers are automatically downloaded or launched if found in your path, if you wish to specify an explicit alternate binary you can specify that in settings: diff --git a/docs/src/debugger.md b/docs/src/debugger.md index bf05de0f6c..b503ff0984 100644 --- a/docs/src/debugger.md +++ b/docs/src/debugger.md @@ -80,7 +80,7 @@ Which one you choose depends on what you are trying to achieve. When launching a new instance, Zed (and the underlying debug adapter) can often do a better job at picking up the debug information compared to attaching to an existing process, since it controls the lifetime of a whole program. Running unit tests or a debug build of your application is a good use case for launching. -Compared to launching, attaching to an existing process might seem inferior, but that's far from truth; there are cases where you cannot afford to restart your program, because for example, the bug is not reproducible outside of a production environment or some other circumstances. +Compared to launching, attaching to an existing process might seem inferior, but that's far from the truth; there are cases where you cannot afford to restart your program, because for example, the bug is not reproducible outside of a production environment or some other circumstances. ## Configuration diff --git a/docs/src/extensions/languages.md b/docs/src/extensions/languages.md index 121357306e..59f20d16de 100644 --- a/docs/src/extensions/languages.md +++ b/docs/src/extensions/languages.md @@ -528,7 +528,7 @@ Each rule in the `semantic_token_rules` array is defined as follows: - `foreground_color`: The foreground color to use for the token type, in hex format (e.g., `"#ff0000"`). - `background_color`: The background color to use for the token type, in hex format (e.g., `"#ff0000"`). - `underline`: A boolean or color to underline with, in hex format. If `true`, then the token will be underlined with the text color. -- `strikethrough`: A boolean or color to strikethrough with, in hex format. If `true`, then the token have a strikethrough with the text color. +- `strikethrough`: A boolean or color to strikethrough with, in hex format. If `true`, then the token will have a strikethrough with the text color. - `font_weight`: One of `"normal"`, `"bold"`. - `font_style`: One of `"normal"`, `"italic"`. diff --git a/docs/src/git.md b/docs/src/git.md index 0d0fcc1a4e..1f9dc4fb9a 100644 --- a/docs/src/git.md +++ b/docs/src/git.md @@ -334,7 +334,7 @@ You can configure multiple custom providers if you work with several self-hosted Zed also has a Copy Permalink feature to create a permanent link to a code snippet on your Git hosting service. These links are useful for sharing a specific line or range of lines in a file at a specific commit. Trigger this action via the [Command Palette](./getting-started.md#command-palette) (search for `permalink`), -by creating a [custom key bindings](key-bindings.md#custom-key-bindings) to the +by creating [custom key bindings](key-bindings.md#custom-key-bindings) for the `editor::CopyPermalinkToLine` or `editor::OpenPermalinkToLine` actions or by simply right clicking and selecting `Copy Permalink` with line(s) selected in your editor. diff --git a/docs/src/globs.md b/docs/src/globs.md index f1fb584ee5..e72c7a92a3 100644 --- a/docs/src/globs.md +++ b/docs/src/globs.md @@ -14,9 +14,9 @@ Zed uses two different rust crates for matching glob patterns: - [ignore crate](https://docs.rs/ignore/latest/ignore/) for matching glob patterns stored in `.gitignore` files - [glob crate](https://docs.rs/glob/latest/glob/) for matching file paths in Zed -While simple expressions are portable across environments (e.g. running `ls *.py` or `*.tmp` in a gitignore) there is significant divergence in the support for and syntax of more advanced features varies (character classes, exclusions, `**`, etc) across implementations. For the rest of this document we will be describing globs as supported in Zed via the `glob` crate implementation. Please see [References](#references) below for documentation links for glob pattern syntax for `.gitignore`, shells and other programming languages. +While simple expressions are portable across environments (e.g. running `ls *.py` or `*.tmp` in a gitignore) there is significant divergence in the support for and syntax of more advanced features (character classes, exclusions, `**`, etc) across implementations. For the rest of this document we will be describing globs as supported in Zed via the `glob` crate implementation. Please see [References](#references) below for documentation links for glob pattern syntax for `.gitignore`, shells and other programming languages. -The `glob` crate is implemented entirely in rust and does not rely on the `glob` / `fnmatch` interfaces provided by your platforms libc. This means that globs in Zed should behave similarly with across platforms. +The `glob` crate is implemented entirely in rust and does not rely on the `glob` / `fnmatch` interfaces provided by your platform's libc. This means that globs in Zed should behave similarly across platforms. ## Introduction @@ -71,7 +71,7 @@ If instead you wanted to restrict yourself only to [Zed Language-Specific Docume When using the "Include" / "Exclude" filters on a Project Search each glob is wrapped in implicit wildcards. For example to exclude any files with license in the path or filename from your search just type `license` in the exclude box. Behind the scenes Zed transforms `license` to `**license**`. This means that files named `license.*`, `*.license` or inside a `license` subdirectory will all be filtered out. This enables users to easily filter for `*.ts` without having to remember to type `**/*.ts` every time. -Alternatively, if in your Zed settings you wanted a [`file_types`](./reference/all-settings.md#file-types) override which only applied to a certain directory you must explicitly include the wildcard globs. For example, if you had a directory of template files with the `html` extension that you wanted to recognize as Jinja2 template you could use the following: +Alternatively, if in your Zed settings you wanted a [`file_types`](./reference/all-settings.md#file-types) override which only applied to a certain directory you must explicitly include the wildcard globs. For example, if you had a directory of template files with the `html` extension that you wanted to recognize as a Jinja2 template you could use the following: ```json [settings] { diff --git a/docs/src/installation.md b/docs/src/installation.md index 2c003da755..152ba85102 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -67,7 +67,7 @@ If this script is insufficient for your use case, you run into problems running ### macOS -Zed supports the follow macOS releases: +Zed supports the following macOS releases: | Version | Codename | Apple Status | Zed Status | | ------------- | -------- | -------------- | ------------------- | diff --git a/docs/src/key-bindings.md b/docs/src/key-bindings.md index ae64ab00b8..490293c9eb 100644 --- a/docs/src/key-bindings.md +++ b/docs/src/key-bindings.md @@ -28,7 +28,7 @@ For more information, see the documentation for [Vim mode](./vim.md) and [Helix ## Keymap Editor -You can access the keymap editor through the {#kb zed::OpenKeymap} action or by running {#action zed::OpenKeymap} action from the command palette. You can easily add or change a keybind for an action with the `Change Keybinding` or `Add Keybinding` button on the command pallets left bottom corner. +You can access the keymap editor through the {#kb zed::OpenKeymap} action or by running {#action zed::OpenKeymap} action from the command palette. You can easily add or change a keybind for an action with the `Change Keybinding` or `Add Keybinding` button on the command palette's left bottom corner. In there, you can see all of the existing actions in Zed as well as the associated keybindings set to them by default. diff --git a/docs/src/languages.md b/docs/src/languages.md index b720e725cc..7c0c618871 100644 --- a/docs/src/languages.md +++ b/docs/src/languages.md @@ -6,7 +6,7 @@ description: "Overview of programming language support in Zed, including built-i # Language Support in Zed Zed supports hundreds of programming languages and text formats. -Some work out-of-the box and others rely on 3rd party extensions. +Some work out-of-the-box and others rely on 3rd party extensions. > The ones included out-of-the-box, natively built into Zed, are marked with \*. diff --git a/docs/src/languages/cpp.md b/docs/src/languages/cpp.md index 1f63460160..44025da554 100644 --- a/docs/src/languages/cpp.md +++ b/docs/src/languages/cpp.md @@ -80,7 +80,7 @@ You can pass any number of arguments to clangd. To see a full set of available o ## Formatting -By default Zed will use the `clangd` language server for formatting C++ code. The Clangd is the same as the `clang-format` CLI tool. To configure this you can add a `.clang-format` file. For example: +By default Zed will use the `clangd` language server for formatting C++ code. Its formatter is the same as the `clang-format` CLI tool. To configure this you can add a `.clang-format` file. For example: ```yaml # yaml-language-server: $schema=https://json.schemastore.org/clang-format-21.x.json diff --git a/docs/src/languages/lua.md b/docs/src/languages/lua.md index 27d3f61363..861dbb710b 100644 --- a/docs/src/languages/lua.md +++ b/docs/src/languages/lua.md @@ -27,7 +27,7 @@ See [LuaLS Settings Documentation](https://luals.github.io/wiki/settings/) for a ### LuaCATS Definitions -LuaLS can provide enhanced LSP autocompletion suggestions and type validation with the help of LuaCATS (Lua Comment and Type System) definitions. These definitions are available for many common Lua libraries, and local paths containing them can be specified via `workspace.library` in `luarc.json`. You can do this via relative paths if you checkout your definitions into the same partent directory of your project (`../playdate-luacats`, `../love2d`, etc). Alternatively you can create submodule(s) inside your project for each LuaCATS definition repo. +LuaLS can provide enhanced LSP autocompletion suggestions and type validation with the help of LuaCATS (Lua Comment and Type System) definitions. These definitions are available for many common Lua libraries, and local paths containing them can be specified via `workspace.library` in `luarc.json`. You can do this via relative paths if you checkout your definitions into the same parent directory of your project (`../playdate-luacats`, `../love2d`, etc). Alternatively you can create submodule(s) inside your project for each LuaCATS definition repo. ### LÖVE (Love2D) {#love2d} diff --git a/docs/src/languages/ocaml.md b/docs/src/languages/ocaml.md index b78302b77b..d6e597f255 100644 --- a/docs/src/languages/ocaml.md +++ b/docs/src/languages/ocaml.md @@ -12,13 +12,13 @@ OCaml support is available through the [OCaml extension](https://github.com/zed- ## Setup Instructions -If you have the development environment already setup, you can skip to [Launching Zed](#launching-zed) +If you have the development environment already set up, you can skip to [Launching Zed](#launching-zed) ### Using Opam Opam is the official package manager for OCaml and is highly recommended for getting started with OCaml. To get started using Opam, please follow the instructions provided [here](https://ocaml.org/install). -Once you install opam and setup a switch with your development environment as per the instructions, you can proceed. +Once you install opam and set up a switch with your development environment as per the instructions, you can proceed. ### Launching Zed diff --git a/docs/src/languages/php.md b/docs/src/languages/php.md index b83e75fb29..8ce513ba05 100644 --- a/docs/src/languages/php.md +++ b/docs/src/languages/php.md @@ -157,7 +157,7 @@ These are common troubleshooting tips, in case you run into issues: - Ensure that you have Xdebug installed for the version of PHP you're running. - Ensure that Xdebug is configured to run in `debug` mode. - Ensure that Xdebug is actually starting a debugging session. -- Ensure that the host and port matches between Xdebug and Zed. +- Ensure that the host and port match between Xdebug and Zed. - Look at the diagnostics log by using the `xdebug_info()` function in the page you're trying to debug. ## Using the Tailwind CSS Language Server with PHP diff --git a/docs/src/languages/python.md b/docs/src/languages/python.md index 4687cf15d8..0dd931f514 100644 --- a/docs/src/languages/python.md +++ b/docs/src/languages/python.md @@ -106,7 +106,7 @@ See: [Working with Language Servers](https://zed.dev/docs/configuring-languages# [basedpyright](https://docs.basedpyright.com/latest/) is the primary Python language server in Zed beginning with Zed v0.204.0. It provides core language server functionality like navigation (go to definition/find all references) and type checking. Compared to Pyright, it adds support for additional language server features (like inlay hints) and checking rules. -Note that while basedpyright in isolation defaults to the `recommended` [type-checking mode](https://docs.basedpyright.com/latest/benefits-over-pyright/better-defaults/#typecheckingmode), Zed configures it to use the less-strict `standard` mode by default, which matches the behavior of Pyright. You can set the type-checking mode for your project using the `typeCheckingMode` setting in `pyrightconfig.json` or `pyproject.toml`, which will override Zed's default. Read on more for more details about how to configure basedpyright. +Note that while basedpyright in isolation defaults to the `recommended` [type-checking mode](https://docs.basedpyright.com/latest/benefits-over-pyright/better-defaults/#typecheckingmode), Zed configures it to use the less-strict `standard` mode by default, which matches the behavior of Pyright. You can set the type-checking mode for your project using the `typeCheckingMode` setting in `pyrightconfig.json` or `pyproject.toml`, which will override Zed's default. Read on for more details about how to configure basedpyright. #### Basedpyright Configuration diff --git a/docs/src/languages/r.md b/docs/src/languages/r.md index 1995bb7c4a..a40cda0242 100644 --- a/docs/src/languages/r.md +++ b/docs/src/languages/r.md @@ -142,7 +142,7 @@ TBD: R REPL Docs ### Ark Installation To use the Zed REPL with R you need to install [Ark](https://github.com/posit-dev/ark), an R Kernel for Jupyter applications. -You can down the latest version from the [Ark GitHub Releases](https://github.com/posit-dev/ark/releases) and then extract the `ark` binary to a directory in your `PATH`. +You can download the latest version from the [Ark GitHub Releases](https://github.com/posit-dev/ark/releases) and then extract the `ark` binary to a directory in your `PATH`. For example to install the latest non-debug build: diff --git a/docs/src/languages/ruby.md b/docs/src/languages/ruby.md index 6f8fc1c495..475c7e26cd 100644 --- a/docs/src/languages/ruby.md +++ b/docs/src/languages/ruby.md @@ -30,7 +30,7 @@ They both have an overlapping feature set of autocomplete, diagnostics, code act In addition to these two language servers, Zed also supports: -- [rubocop](https://github.com/rubocop/rubocop) which is a static code analyzer and linter for Ruby. Under the hood, it's also used by Zed as a language server, but its functionality is complimentary to that of solargraph and ruby-lsp. +- [rubocop](https://github.com/rubocop/rubocop) which is a static code analyzer and linter for Ruby. Under the hood, it's also used by Zed as a language server, but its functionality is complementary to that of solargraph and ruby-lsp. - [sorbet](https://sorbet.org/) which is a static type checker for Ruby with a custom gradual type system. - [steep](https://github.com/soutaro/steep) which is a static type checker for Ruby that uses Ruby Signature (RBS). - [Herb](https://herb-tools.dev) which is a language server for ERB files. diff --git a/docs/src/languages/scala.md b/docs/src/languages/scala.md index 0f3b0018bb..d0b2b1f3e7 100644 --- a/docs/src/languages/scala.md +++ b/docs/src/languages/scala.md @@ -27,7 +27,7 @@ Behavior of the Metals language server can be controlled with: - `.scalafix.conf` file - See [Scalafix Configuration](https://scalacenter.github.io/scalafix/docs/users/configuration.html) - `.scalafmt.conf` file - See [Scalafmt Configuration](https://scalameta.org/scalafmt/docs/configuration.html) -You can place these files in the root of your project or specifying their location in the Metals configuration. See [Metals User Configuration](https://scalameta.org/metals/docs/editors/user-configuration) for more. +You can place these files in the root of your project or specify their location in the Metals configuration. See [Metals User Configuration](https://scalameta.org/metals/docs/editors/user-configuration) for more.