Revert "Add docs_preprocessor crate to support Zed Docs" (#16880)
Temporarily revert #16700 to deal with this error: `error: manifest path `../crates/docs_preprocessor/Cargo.toml` does not exist` as it was causing the docs-preprocessor not to run, meaning unexpanded templates were showing up in the public docs. Reverts zed-industries/zed#16700 Release Notes: - N/A
This commit is contained in:
Nate Butler
GitHub
parent
c658ad8380
commit
2a03dde538
16 changed files with 24 additions and 639 deletions
|
|
@ -2,8 +2,7 @@
|
|||
|
||||
The assistant panel provides you with a way to interact with large language models. The assistant is useful for various tasks, such as generating code, asking questions about existing code, and even writing plaintext, such as emails and documentation.
|
||||
|
||||
To open the assistant panel, toggle the right dock by using the {#action workspace::ToggleRightDock} action in the command palette or by using the
|
||||
{#kb workspace::ToggleRightDock} shortcut.
|
||||
To open the assistant panel, toggle the right dock by using the `workspace: toggle right dock` action in the command palette or by using the <kbd>cmd-r|ctrl-alt-b</kbd> shortcut.
|
||||
|
||||
> **Note**: A custom [key binding](../key-bindings.md) can be set to toggle the right dock.
|
||||
|
||||
|
|
@ -11,9 +10,9 @@ Once you have [configured a provider](./configuration.md#providers), you can int
|
|||
|
||||
|
||||
|
||||
To create a new context editor, press {#kb workspace::NewFile} or use the menu in the top right of the assistant panel and select the `New Context` option.
|
||||
To create a new context editor, press <kbd>cmd-n|ctrl-n</kbd> or use the menu in the top right of the assistant panel and select the `New Context` option.
|
||||
|
||||
In the context editor, select a model from one of the configured providers, type a message in the `You` block, and submit with {#kb assistant::Assist}.
|
||||
In the context editor, select a model from one of the configured providers, type a message in the `You` block, and submit with <kbd>cmd-enter|ctrl-enter</kbd>.
|
||||
|
||||
### Interacting with the Assistant
|
||||
|
||||
|
|
@ -31,11 +30,11 @@ To begin, select a model and type a message in a `You` block.
|
|||
|
||||
As you type, the remaining tokens count for the selected model is updated.
|
||||
|
||||
Inserting text from an editor is as simple as highlighting the text and running `assistant: quote selection` ({#kb assistant::QuoteSelection}); Zed will wrap it in a fenced code block if it is code.
|
||||
Inserting text from an editor is as simple as highlighting the text and running `assistant: quote selection` (<kbd>cmd+shift+>|ctrl+shift+></kbd>); Zed will wrap it in a fenced code block if it is code.
|
||||
|
||||
|
||||
|
||||
To submit a message, use {#kb assistant::Assist}(`assistant: assist`). Unlike typical chat applications where pressing <kbd>enter</kbd> would submit the message, in the assistant editor, our goal was to make it feel as close to a regular editor as possible. So, pressing {#kb editor::Newline} simply inserts a new line.
|
||||
To submit a message, use <kbd>cmd-enter|ctrl-enter</kbd> (`assistant: assist`). Unlike typical chat applications where pressing <kbd>enter</kbd> would submit the message, in the assistant editor, our goal was to make it feel as close to a regular editor as possible. So, pressing <kbd>enter</kbd> simply inserts a new line.
|
||||
|
||||
After submitting a message, the assistant's response will be streamed below, in an `Assistant` message block.
|
||||
|
||||
|
|
@ -54,12 +53,12 @@ Simple back-and-forth conversations work well with the assistant. However, there
|
|||
The assistant gives you the flexibility to have control over the context. You can freely edit any previous text, including the responses from the assistant. If you want to remove a message block entirely, simply place your cursor at the beginning of the block and use the `delete` key. A typical workflow might involve making edits and adjustments throughout the context to refine your inquiry or provide additional information. Here's an example:
|
||||
|
||||
1. Write text in a `You` block.
|
||||
2. Submit the message with {#kb assistant::Assist}.
|
||||
2. Submit the message with <kbd>cmd-enter|ctrl-enter</kbd>.
|
||||
3. Receive an `Assistant` response that doesn't meet your expectations.
|
||||
4. Cancel the response with <kbd>escape</kbd>.
|
||||
5. Erase the content of the `Assistant` message block and remove the block entirely.
|
||||
6. Add additional context to your original message.
|
||||
7. Submit the message with {#kb assistant::Assist}.
|
||||
7. Submit the message with <kbd>cmd-enter|ctrl-enter</kbd>.
|
||||
|
||||
Being able to edit previous messages gives you control over how tokens are used. You don't need to start up a new context to correct a mistake or to add additional information, and you don't have to waste tokens by submitting follow-up corrections.
|
||||
|
||||
|
|
|
|||
|
|
@ -13,9 +13,9 @@ Consider renaming `zed: Open Local Settings` to `zed: Open Project Settings`.
|
|||
TBD: Add settings documentation about how settings are merged as overlays. E.g. project>local>default. Note how settings that are maps are merged, but settings that are arrays are replaced and must include the defaults.
|
||||
-->
|
||||
|
||||
Your settings file can be opened with {#kb zed::OpenSettings}. By default it is located at `~/.config/zed/settings.json`, though if you have XDG_CONFIG_HOME in your environment on Linux it will be at `$XDG_CONFIG_HOME/zed/settings.json` instead.
|
||||
Your settings file can be opened with <kbd>cmd-,|ctrl-,</kbd>. By default it is located at `~/.config/zed/settings.json`, though if you have XDG_CONFIG_HOME in your environment on Linux it will be at `$XDG_CONFIG_HOME/zed/settings.json` instead.
|
||||
|
||||
This configuration is merged with any local configuration inside your projects. You can open the project settings by running {#action zed::OpenLocalSettings} from the command palette. This will create a `.zed` directory containing`.zed/settings.json`.
|
||||
This configuration is merged with any local configuration inside your projects. You can open the project settings by running `zed: Open Local Settings` from the command palette. This will create a `.zed` directory containing`.zed/settings.json`.
|
||||
|
||||
Although most projects will only need one settings file at the root, you can add more local settings files for subdirectories as needed. Not all settings can be set in local files, just those that impact the behavior of the editor and language tooling. For example you can set `tab_size`, `formatter` etc. but not `theme`, `vim_mode` and similar.
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ The syntax for configuration files is a super-set of JSON that allows `//` comme
|
|||
|
||||
## Default settings
|
||||
|
||||
You can find the default settings for your current Zed by running {#action zed::OpenDefaultSettings} from the command palette.
|
||||
You can find the default settings for your current Zed by running `zed: Open Default Settings` from the command palette.
|
||||
|
||||
Extensions that provide language servers may also provide default settings for those language servers.
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ If this script is insufficient for your use case or you run into problems runnin
|
|||
|
||||
The Command Palette is the main way to access functionality in Zed, and its keybinding is the first one you should make yourself familiar with.
|
||||
|
||||
To open the Command Palette, use {#kb command_palette::Toggle}.
|
||||
To open the Command Palette, use <kbd>cmd-shift-p|ctrl-shift-p</kbd>.
|
||||
|
||||
The Command Palette allows you to access pretty much any functionality that's available in Zed.
|
||||
|
||||
|
|
@ -54,11 +54,11 @@ Any time you see instructions that include commands of the form `zed: ...` or `e
|
|||
|
||||
## Configure Zed
|
||||
|
||||
Use {#kb zed::OpenSettings} to open your custom settings to set things like fonts, formatting settings, per-language settings, and more.
|
||||
Use <kbd>cmd-,|ctrl-,</kbd> to open your custom settings to set things like fonts, formatting settings, per-language settings, and more.
|
||||
|
||||
On macOS, you can access the default configuration using the `Zed > Settings > Open Default Settings` menu item. See [Configuring Zed](./configuring-zed.md) for all available settings.
|
||||
|
||||
On Linux, you can access the default configuration via the Command Palette. Open it with {#kb zed::OpenDefaultSettings} and type in `zed: open default settings` and then hit return.
|
||||
On Linux, you can access the default configuration via the Command Palette. Open it with <kbd>ctrl-shift-p</kbd> and type in `zed: open default settings` and then hit return.
|
||||
|
||||
## Set up your key bindings
|
||||
|
||||
|
|
|
|||
|
|
@ -4,9 +4,7 @@ Zed collects anonymous telemetry data to help the team understand how people are
|
|||
|
||||
## Configuring Telemetry Settings
|
||||
|
||||
You have full control over what data is sent out by Zed. To enable or disable some or all telemetry types, open your `settings.json` file via {#action zed::OpenSettings}({#kb zed::OpenSettings}) from the command palette.
|
||||
|
||||
Insert and tweak the following:
|
||||
You have full control over what data is sent out by Zed. To enable or disable some or all telemetry types, open your `settings.json` file via `zed: open settings` from the command palette. Insert and tweak the following:
|
||||
|
||||
```json
|
||||
"telemetry": {
|
||||
|
|
@ -15,7 +13,7 @@ Insert and tweak the following:
|
|||
},
|
||||
```
|
||||
|
||||
The telemetry settings can also be configured via the welcome screen, which can be invoked via the {#action workspace::Welcome} action in the command palette.
|
||||
The telemetry settings can also be configured via the `welcome` screen, which can be invoked via the `workspace: welcome` action in the command palette.
|
||||
|
||||
## Dataflow
|
||||
|
||||
|
|
@ -46,7 +44,7 @@ Usage Data does not include any of Your software code or sensitive project detai
|
|||
|
||||
Usage Data is associated with a secure random telemetry ID which may be linked to Your email address. This linkage currently serves two purposes: (1) it allows Zed to analyze usage patterns over time while maintaining Your privacy; and (2) it enables Zed to reach out to specific user groups for feedback and improvement suggestions.
|
||||
|
||||
You can audit the metrics data that Zed has reported by running the command {#action zed::OpenTelemetryLog} from the command palette, or clicking `Help > View Telemetry Log` in the application menu.
|
||||
You can audit the metrics data that Zed has reported by running the command `zed: open telemetry log` from the command palette, or clicking `Help > View Telemetry Log` in the application menu.
|
||||
|
||||
You can see the full list of the event types and exactly the data sent for each by inspecting the `Event` enum and the associated structs in [crates/telemetry_events/src/telemetry_events.rs](https://github.com/zed-industries/zed/blob/main/crates/telemetry_events/src/telemetry_events.rs#L63] in the zed repo.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue