Skip to content

Commit

Permalink
Merge pull request #3847 from continuedev/nate/yaml-docs-block-syntax
Browse files Browse the repository at this point in the history
update yaml docs for new block syntax
  • Loading branch information
sestinj authored Jan 28, 2025
2 parents ce2bfed + 3d4984c commit f85bcac
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 25 deletions.
14 changes: 7 additions & 7 deletions docs/docs/yaml-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ Note that the `repoMapFileSelection` experimental model role has been deprecated

The JSON `contextProviders` field is replaced by the YAML `context` array.

- JSON `name` maps to `uses`
- JSON `params` map to `with`
- JSON `name` maps to `provider`
- JSON `params` map to `params`

**Before**

Expand Down Expand Up @@ -181,14 +181,14 @@ The JSON `contextProviders` field is replaced by the YAML `context` array.

```yaml title="config.yaml"
context:
- uses: docs
- provider: docs
- uses: codebase
with:
- provider: codebase
params:
nRetrieve: 30
nFinal: 3
- uses: diff
- params: diff
```

### System Message
Expand Down Expand Up @@ -337,7 +337,7 @@ The following top-level fields from `config.json` have been deprecated. Most UI-
- `customCommands`
- `disableSessionTitles`
- `experimental`
- `allowAnonymousTelemetry` (moved to user/IDE level)
- `allowAnonymousTelemetry` (automatically migrated to IDE settings)
- `ui` (moved to user/IDE level)
- `userToken`
- `disableIndexing` (moved to user/IDE level)
Expand Down
35 changes: 17 additions & 18 deletions docs/docs/yaml-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords: [config, yaml, configuration, customize, customization]

# Config YAML Reference

<!-- TODO - data and packages sections -->
<!-- TODO - data section -->

Continue can be configured using a YAML file `config.yaml` which for local configuration can be placed in your global `.continue` folder (`~/.continue` on Mac, `%USERPROFILE%\.continue`)

Expand All @@ -23,7 +23,6 @@ Config YAML does not work alongside `config.json` - it replaces it. View the **[
The top-level properties in the `config.yaml` configuration file are:

- [`name`](#name) (**required**)
<!-- - [`packages`](#packages) -->
- [`version`](#version) (**required**)
- [`models`](#models)
- [`context`](#context)
Expand Down Expand Up @@ -120,22 +119,22 @@ More information about usage/params for each context provider can be found [here

**Properties:**

- `uses` (**required**): The identifier or name of the context provider (e.g., `code`, `docs`, `web`).
- `with`: Optional parameters to configure the context provider's behavior.
- `provider` (**required**): The identifier or name of the context provider (e.g., `code`, `docs`, `web`).
- `params`: Optional parameters to configure the context provider's behavior.

**Example:**

```yaml title="config.yaml"
context:
- uses: files
- uses: code
- uses: codebase
with:
- provider: files
- provider: code
- provider: codebase
params:
nFinal: 10
- uses: docs
- uses: diff
- uses: folder
- uses: terminal
- provider: docs
- provider: diff
- provider: folder
- provider: terminal
```

---
Expand Down Expand Up @@ -301,12 +300,12 @@ prompts:
Please write a complete suite of unit tests for this function. You should use the Jest testing framework. The tests should cover all possible edge cases and should be as thorough as possible. You should also include a description of each test case.
context:
- uses: diff
- uses: file
- uses: codebase
- uses: code
- uses: docs
with:
- provider: diff
- provider: file
- provider: codebase
- provider: code
- provider: docs
params:
startUrl: https://docs.example.com/introduction
maxDepth: 3
Expand Down

0 comments on commit f85bcac

Please sign in to comment.