From 3d4984c7c1985f1d65388ca00a14c69a59430fd2 Mon Sep 17 00:00:00 2001 From: Nate Date: Sat, 25 Jan 2025 14:47:34 -0800 Subject: [PATCH] update yaml docs for new block syntax --- docs/docs/yaml-migration.md | 14 +++++++------- docs/docs/yaml-reference.md | 35 +++++++++++++++++------------------ 2 files changed, 24 insertions(+), 25 deletions(-) diff --git a/docs/docs/yaml-migration.md b/docs/docs/yaml-migration.md index ad62efaa71..d0679c5ca5 100644 --- a/docs/docs/yaml-migration.md +++ b/docs/docs/yaml-migration.md @@ -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** @@ -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 @@ -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) diff --git a/docs/docs/yaml-reference.md b/docs/docs/yaml-reference.md index b273353a4a..e504c95fda 100644 --- a/docs/docs/yaml-reference.md +++ b/docs/docs/yaml-reference.md @@ -6,7 +6,7 @@ keywords: [config, yaml, configuration, customize, customization] # Config YAML Reference - + 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`) @@ -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**) - - [`version`](#version) (**required**) - [`models`](#models) - [`context`](#context) @@ -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 ``` --- @@ -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