Skip to content

Commit ae9c97c

Browse files
authored
Merge pull request continuedev#4841 from continuedev/dallin/yaml-docs-priority
Edit mode and Settings Page docs updates
2 parents df2fd3e + 59f1013 commit ae9c97c

27 files changed

+107
-81
lines changed

docs/docs/autocomplete/how-to-customize.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ keywords: [customize]
55
sidebar_position: 5
66
---
77

8-
Continue offers a handful of settings to customize autocomplete behavior. For the most part, these options can be found in the [User Settings Page](../customize/deep-dives/settings.md).
8+
Continue offers a handful of settings to customize autocomplete behavior. Visit the [User Settings Page](../customize/deep-dives/settings.md) to manage these settings.
99

1010
For a comprehensive guide on all configuration options and their impacts, see the [Autocomplete deep dive](../customize/deep-dives/autocomplete.mdx).

docs/docs/customize/deep-dives/autocomplete.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ Explore autocomplete model configurations on [the hub](https://hub.continue.dev/
9090

9191
### Autocomplete User Settings
9292

93+
{/* - `Use autocomplete cache`: If on, caches completions */}
9394
The following settings can be configured for autocompletion in the IDE extension [User Settings Page](./settings.md):
9495

95-
- `Use autocomplete cache`: If on, caches completions
9696
- `Multiline Autocompletions`: Controls multiline completions for autocomplete. Can be set to `always`, `never`, or `auto`. Defaults to `auto`
9797
- `Disable autocomplete in files`: List of comma-separated glob pattern to disable autocomplete in matching files. E.g., "\_/.md, \*/.txt"
9898

docs/docs/customize/deep-dives/docs.mdx

+5-2
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,10 @@ If your documentation is private, you can skip the default crawler and use a loc
215215
</TabItem>
216216
</Tabs>
217217

218-
The default local crawler is a lightweight tool that cannot render sites that are dynamically generated using JavaScript. If your sites need to be rendered, you can enable the experimental `Use Chromium for Docs Crawling` feature from your [User Settings Page](./settings.md) This will download and install Chromium to `~/.continue/.utils`, and use it as the local crawler.
218+
:::info
219+
Chromium crawling has been deprecated
220+
{/* The default local crawler is a lightweight tool that cannot render sites that are dynamically generated using JavaScript. If your sites need to be rendered, you can enable the experimental `Use Chromium for Docs Crawling` feature from your [User Settings Page](../deep-dives/settings.md) This will download and install Chromium to `~/.continue/.utils`, and use it as the local crawler. */}
221+
:::
219222

220223
Further notes:
221224

@@ -401,4 +404,4 @@ The following configuration example includes:
401404
</TabItem>
402405
</Tabs>
403406

404-
This could also involve enabling Chromium as a backup for local documentation the [User Settings Page](./settings.md).
407+
{/* This could also involve enabling Chromium as a backup for local documentation the [User Settings Page](../deep-dives/settings.md). */}

docs/docs/customize/deep-dives/settings.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Which takes you to this page:
1414

1515
![User Settings Page](/img/settings-page.png)
1616

17-
Click the `Open Assistant configuration` button to open your configuration file. See the [Configuration Reference](../../reference.md) for more information.
18-
1917
Below that, the following settings which are not part of a configuration file are available:
2018

19+
- `Show Session Tabs`: If on, displays tabs above the chat as an alternative way to organize and access your sessions. Off by default
2120
- `Wrap Codeblocks`: If on, enables text wrapping in code blocks. Off by default.
22-
- `Display Raw Markdown`: If on, shows raw markdown in responses. Off by default.
23-
- `Allow Anonymous Telemetry`: If on, allows Continue to send anonymous telemetry. **On** by default.
24-
- `Disable Indexing`: Prevents indexing of the codebase, useful primarily for debugging purposes. Off by default.
25-
- `Disable Session Titles`: Prevents generating summary titles for each chat session when turned on. Off by default
26-
- `Response Text to Speech`: If on, reads LLM responses aloud with TTS. Off by default.
2721
- `Show Chat Scrollbar`: If on, enables a scrollbar in the chat window. Off by default.
28-
- `Use autocomplete cache`: If on, caches completions.
29-
- `Use Chromium for Docs Crawling`: Use Chromium to crawl docs locally. Useful if the default Cheerio crawler fails on sites that require JavaScript rendering. Downloads and installs Chromium to ~/.continue/.utils. Off by default
30-
- `Codeblock Actions Position`: Sets the position for the actions that show when hovering over codeblocks. Defaults to `top`
31-
- `Multiline Autocompletions`: Controls multiline completions for autocomplete. Can be set to `always`, `never`, or `auto`. Defaults to `auto`
22+
- `Text-to-Speech Output`: If on, reads LLM responses aloud with TTS. Off by default.
23+
- `Enable Session Titles`: If on, generates summary titles for each chat session after the first message, using the current Chat model. On by default.
24+
- `Format Markdown`: If off, shows responses as raw text. On by default.
25+
- `Allow Anonymous Telemetry`: If on, allows Continue to send anonymous telemetry. **On** by default.
26+
- `Enable Indexing`: Enables indexing of the codebase for the @codebase and @code context providers. **On** by default.
3227
- `Font Size`: Specifies base font size for UI elements
33-
- `Workspace prompts path`: Where to find Prompt Files in a workspace - replaces the default .continue/prompts
28+
- `Multiline Autocompletions`: Controls multiline completions for autocomplete. Can be set to `always`, `never`, or `auto`. Defaults to `auto`
3429
- `Disable autocomplete in files`: List of comma-separated glob pattern to disable autocomplete in matching files. E.g., "\_/.md, \*/.txt"
30+
31+
<!-- - `Use autocomplete cache`: If on, caches completions. -->
32+
<!-- - `Use Chromium for Docs Crawling`: Use Chromium to crawl docs locally. Useful if the default Cheerio crawler fails on sites that require JavaScript rendering. Downloads and installs Chromium to ~/.continue/.utils. Off by default -->
33+
<!-- - `Codeblock Actions Position`: Sets the position for the actions that show when hovering over codeblocks. Defaults to `top` -->
34+
<!-- - `Workspace prompts path`: Where to find Prompt Files in a workspace - replaces the default .continue/prompts -->

docs/docs/customize/model-roles/intro.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ These roles can be specified for a `config.yaml` model block using `roles`. See
2222

2323
## Selecting model roles
2424

25-
You can control which of the models in your assistant for a given role will be currently used for that role. Visit the [Settings page](../deep-dives/settings.md) and go to the **Active Models** section.
25+
You can control which of the models in your assistant for a given role will be currently used for that role. Above the main input, click the 3 dots and then the cube icon to expand the `Models` section. Then you can use the dropdowns to select an active model for each role.
2626

2727
![Settings Active Models Section](/img/settings-model-roles.png)
2828

2929
:::info
30-
Note that `roles` do not exist within `config.json` - they are infered by the top level keys like `embeddingsProvider`
30+
`roles` are not explicitly defined within `config.json` (deprecated) - they are infered by the top level keys like `embeddingsProvider`
3131
:::

docs/docs/edit/context-selection.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ keywords: [edit, cmd i, works]
99

1010
The input you provide is included in the prompt.
1111

12-
## Highlighted code
12+
## Code to Edit
1313

14-
The highlighted code you’ve selected is included in the prompt. This is the only section of code that the model will attempt to edit.
14+
The **entire contents** of each file (the current file for Jetbrains inline Edit, each `Code to Edit` item for VS Code Edit mode) are included in the prompt for context. The model will only attempt to edit the highlighted/specified ranges.
1515

16-
## Current file
16+
## Context Providers
1717

18-
The entire contents of the file containing your highlighted code selection are included as additional context. This gives the model a broader understanding of the code's environment. If the file is too large to fit within the context window, we will trim the file's contents to fit.
18+
In VS Code Edit mode, you can use `@` to add context using [Context Providers](../customize/context-providers.mdx), similar to [Chat](../chat/context-selection.md). Some context providers may be disabled in Edit mode.

docs/docs/edit/how-it-works.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: How Edit works
33
sidebar_position: 4
4-
description: How Edit works
4+
description: How it works
55
keywords: [edit, cmd l, works]
66
---
77

8-
Using the highlighted code, the contents of the file containing your highlight, and your input instructions, we prompt the model to edit the code according to your instructions. No other additional context is provided to the model.
8+
Using the highlighted code, the contents of the current file containing your highlight, and your input instructions, we prompt the model to edit the code according to your instructions. No other additional context is provided to the model.
99

1010
The model response is then streamed directly back to the highlighted range in your code, where we apply a diff formatting to show the proposed changes.
1111

1212
If you accept the diff, we remove the previously highlighted lines, and if you reject the diff, we remove the proposed changes.
1313

14-
If you would like to view the exact prompt that is sent to the model during an edit, you can [view this in the prompt logs](../troubleshooting.mdx#check-the-logs).
14+
If you would like to view the exact prompt that is sent to the model during an edit, you can [find it in the prompt logs](../troubleshooting.mdx#check-the-logs).

docs/docs/edit/how-to-customize.mdx

+6-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ description: How to customize Edit
55
keywords: [edit, cmd i, works]
66
---
77

8-
import TabItem from "@theme/TabItem";
9-
import Tabs from "@theme/Tabs";
8+
## Setting active Edit/Apply model
109

11-
You can configure a particular model to be used for Edit by setting/overriding `roles` in the model's YAML config. See [Edit role](../customize/model-roles/edit.mdx) for more details.
10+
You can configure particular models from your Assistant to be used for Edit and Apply requests (see [How it Works](./how-it-works.md)). Above the main input, click the 3 dots and then the cube icon to expand the `Models` section. Then, you can use the dropdowns to select models to use for Edit and Apply.
11+
12+
![Settings Active Models Section](/img/model-roles-edit.png)
13+
14+
See [Edit role](../customize/model-roles/edit.mdx) and [Apply role](../customize/model-roles/apply.mdx) for more details.

docs/docs/edit/how-to-use-it.md

+45-3
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ keywords: [edit, cmd l, use]
1010

1111
## How to use it
1212

13-
Edit is a convenient way to modify code without leaving your current file. Highlight a block of code, describe your code changes, and a diff will be streamed inline to your file which you can accept or reject.
13+
Edit is a convenient way to make quick changes to specific code and files. Select code, describe your code changes, and a diff will be streamed inline to your file which you can accept or reject.
1414

15-
Edit is best used for small, quick changes such as:
15+
Edit is recommended for small, targeted changes, such as
1616

1717
- Writing comments
1818
- Generating unit tests
1919
- Refactoring functions or methods
2020

2121
## Highlight code and activate
2222

23-
Highlight the block of code you would like to modify, and press <kbd>cmd/ctrl</kbd> + <kbd>i</kbd> to activate the edit input.
23+
Highlight the block of code you would like to modify and press <kbd>cmd/ctrl</kbd> + <kbd>i</kbd> to active Edit mode. You can also enter Edit mode by pressing <kbd>cmd/ctrl</kbd> + <kbd>i</kbd> with no code highlighted.
2424

2525
## Describe code changes
2626

@@ -35,3 +35,45 @@ You can navigate through each proposed change, accepting or rejecting them using
3535
You can also accept or reject all changes at once using <kbd>cmd/ctrl</kbd> + <kbd>shift</kbd> + <kbd>enter</kbd> (to accept) or <kbd>cmd/ctrl</kbd> + <kbd>shift</kbd> + <kbd>delete/backspace</kbd> (to reject).
3636

3737
If you want to request a new suggestion for the same highlighted code section, you can use <kbd>cmd/ctrl</kbd> + <kbd>i</kbd> to re-prompt the model.
38+
39+
## VS Code
40+
41+
In VS Code, Edit is implemented in the extension sidebar with a similar interface to [Chat](../chat/how-it-works.md), and you can also enter Edit mode by using the Mode Selector below the main Chat input to select `Edit`.
42+
43+
![edit mode selected](/img/select-edit-mode.png)
44+
45+
You can also reject and accept diffs using the `Reject All` and `Accept All` buttons that show up in the Chat when diffs are present (see examples below).
46+
47+
### Adding Code to Edit
48+
49+
Along with adding highlighted code, you can also manually add files to edit using the `Add file` combobox or by clicking the dropdown and selecting `Add all open files` to add all files that are currently open in the editor.
50+
51+
**_Add file combobox_**
52+
53+
![edit mode add file combobox](/img/edit-mode-add-files.png)
54+
55+
**_Add all open files dropdown_**
56+
57+
![edit mode add file combobox](/img/edit-mode-add-all-open-files.png)
58+
59+
### Single File Edit
60+
61+
If one file/range is present in `Code to Edit` on submission, Continue will prompt the Edit model and then automatically stream the diff into the editor.
62+
63+
![Edit mode single file diffs](/img/edit-mode-single-file-diff.png)
64+
65+
### Multi-File Edit
66+
67+
If multiple files/ranges are present in `Code to Edit` on submission, Continue will prompt the Edit model to output codeblocks per-file, which the user can then choose to apply and accept/reject independently.
68+
69+
**_Generated Content_**
70+
71+
![Edit mode multi file generated content](/img/edit-mode-multi-file-generation.png)
72+
73+
**_Diffs_**
74+
75+
![Edit mode multi file diffs](/img/edit-mode-multi-file-diffs.png)
76+
77+
## Jetbrains
78+
79+
In Jetbrains, Edit is implemented as an inline popup (see the header GIF example) for single-file edit. Multi-file edit mode is not currently implemented.

docs/docs/edit/model-setup.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: How to set up an Edit model
55
keywords: [edit, cmd l, model]
66
---
77

8-
By default, Edit uses the [same model as Chat](../chat/model-setup.mdx) since we recommend a similar, 400B+ parameter model or one of the frontier model for code edits.
8+
By default, Edit uses the [same model as Chat](../chat/model-setup.mdx), and we recommend [Claude 3.7 Sonnet](https://hub.continue.dev/anthropic/claude-3-7-sonnet) from Anthropic. Visit [the Hub](https://hub.continue.dev/explore/models?roles=edit) to explore other Edit models.
99

10-
Visit [the hub](https://hub.continue.dev/explore/models?roles=edit) to explore Edit models.
11-
12-
You can configure a different model to be used for edits by updating your [configuration](../customize/model-roles/edit.mdx).
10+
For the best Edit experience, we also recommend setting up an Apply model, specially trained to apply diffs to files. We recommend [Morph v0 Fast Apply](https://hub.continue.dev/morphllm/morph-v0) or [Relace Instant Apply](https://hub.continue.dev/relace/instant-apply). Explore other apply models on the [the Hub](https://hub.continue.dev/explore/models?roles=apply).

docs/docs/json-reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ Example
405405

406406
### Fully deprecated settings
407407

408-
Some deprecated `config.json` settings are no longer stored in config and have been moved to be editable through the [User Settings Page](./customize/deep-dives/settings.md). If found in `config.json`, they will be migrated to the [User Settings Page](./customize/deep-dives/settings.md) and removed from `config.json`.
408+
Some deprecated `config.json` settings are no longer stored in config and have been moved to be editable through the [User Settings Page](./customize/deep-dives/settings.md). If found in `config.json`, they will be auto-migrated to User Settings and removed from `config.json`.
409409

410410
- `allowAnonymousTelemetry`: This value will be migrated to the safest merged value (`false` if either are `false`).
411411
- `promptPath`: This value will override during migration.

docs/docs/reference.md

+8-28
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@ keywords: [config, yaml, configuration, customize, customization]
88

99
## Introduction
1010

11-
Continue hub assistants are defined using the `config.yaml` specification. Local assistants can also be configured using a YAML file `config.yaml` placed in your global `.continue` folder (`~/.continue` on Mac, `%USERPROFILE%\.continue`)
11+
Continue hub assistants are defined using the `config.yaml` specification. Assistants can be loaded from [the Hub](https://hub.continue.dev/explore/assistants) or locally
12+
13+
- [Continue Hub](https://hub.continue.dev/explore/assistants) - YAML is stored on the hub and automatically synced to the extension
14+
- Locally
15+
- in your global `.continue` folder (`~/.continue` on Mac, `%USERPROFILE%\.continue`) within `.continue/assistants`. The name of the file will be used as the display name of the assistant, e.g. `My Assistant.yaml`
16+
- in your workspace in a `/.continue/assistants` folder, with the same naming convention
1217

1318
:::info
14-
Config YAML replaces `config.json`. View the **[Migration Guide](/yaml-migration)**.
19+
Config YAML replaces `config.json`, which is deprecated. View the **[Migration Guide](/yaml-migration)**.
1520
:::
1621

1722
An assistant is made up of:
@@ -32,7 +37,7 @@ Hub blocks and assistants are identified with a slug in the format `owner-slug/b
3237
Blocks can be imported into an assistant by adding a `uses` clause under the block type. This can be alongside other `uses` clauses or explicit blocks of that type.
3338

3439
:::info
35-
Note that `uses` blocks cannot be used with a local `config.yaml`
40+
Note that local assistants cannot use blocks that require organization-level secrets.
3641
:::
3742

3843
For example, the following assistant imports an Anthropic model and defines an Ollama DeepSeek one.
@@ -473,28 +478,3 @@ models:
473478
roles:
474479
- autocomplete
475480
```
476-
477-
### Fully deprecated settings
478-
479-
Some deprecated `config.json` settings are no longer stored in config and have been moved to be editable through the [User Settings Page](./customize/deep-dives/settings.md). If found in `config.json`, they will be migrated to the [User Settings Page](./customize/deep-dives/settings.md) and removed from `config.json`.
480-
481-
- `allowAnonymousTelemetry`: This value will be migrated to the safest merged value (`false` if either are `false`).
482-
- `promptPath`: This value will override during migration.
483-
- `disableIndexing`: This value will be migrated to the safest merged value (`true` if either are `true`).
484-
- `disableSessionTitles`/`ui.getChatTitles`: This value will be migrated to the safest merged value (`true` if either are `true`). `getChatTitles` takes precedence if set to false
485-
- `tabAutocompleteOptions`
486-
- `useCache`: This value will override during migration.
487-
- `disableInFiles`: This value will be migrated to the safest merged value (arrays of file matches merged/deduplicated)
488-
- `multilineCompletions`: This value will override during migration.
489-
- `experimental`
490-
- `useChromiumForDocsCrawling`: This value will override during migration.
491-
- `readResponseTTS`: This value will override during migration.
492-
- `ui` - all will override during migration
493-
494-
- `codeBlockToolbarPosition`
495-
- `fontSize`
496-
- `codeWrap`
497-
- `displayRawMarkdown`
498-
- `showChatScrollbar`
499-
500-
See [User Settings Page](./customize/deep-dives/settings.md) for more information about each option.

docs/docs/yaml-migration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ mcpServers:
327327

328328
## Deprecated configuration options
329329

330-
Some deprecated `config.json` settings are no longer stored in config and have been moved to be editable through the [User Settings Page](./customize/deep-dives/settings.md) (Gear Icon). If found in `config.json`, they will be migrated to the [User Settings Page](./customize/deep-dives/settings.md) and removed from `config.json`.
330+
Some deprecated `config.json` settings are no longer stored in config and have been moved to be editable through the [User Settings Page](./customize/deep-dives/settings.md) (Gear Icon). If found in `config.json`, they will be auto-migrated to User Settings and removed from `config.json`.
331331

332332
See the [JSON Config Reference](./json-reference#fully-deprecated-settings) for more information on fully deprecated options.
333333

docs/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ const sidebars = {
171171
type: "link",
172172
label: "Customize",
173173
href: "/customize/overview",
174-
}
174+
},
175175
],
176176
};
177177

26.9 KB
Loading
28.7 KB
Loading
256 KB
Loading
Loading
70.7 KB
Loading
105 KB
Loading

docs/static/img/header-buttons.png

-596 Bytes
Loading
-74.1 KB
Loading

docs/static/img/model-roles-edit.png

40.7 KB
Loading

docs/static/img/select-edit-mode.png

22.4 KB
Loading
-13.9 KB
Loading

docs/static/img/settings-page.png

-8.54 KB
Loading

0 commit comments

Comments
 (0)