diff --git a/docs/cody/capabilities/ignore-context.mdx b/docs/cody/capabilities/ignore-context.mdx new file mode 100644 index 000000000..a896ba889 --- /dev/null +++ b/docs/cody/capabilities/ignore-context.mdx @@ -0,0 +1,27 @@ +# Cody Ignore + +This feature is currently in the Experimental stage and only supported with VS Code extension. + +This guide will walk you through the process of ignoring specific files or folders in your codebase when using Cody. + +## Enabling Unstable Features + +To use the ignore context feature, you first need to enable unstable features in Cody. Here's how: + +1. Open your settings in Cody Extension +2. Next go to the `settings.json` file +3. Add a new line: `"cody.unstableFeatures": true`. + +This will enable experimental features, including the ignore context feature. + +## Using the Ignore Context Feature + +To ignore specific files or folders from the context taken by Cody, you need to create a `ignore` file in your project. Here's how: + +1. Create a new folder in your project root named `.cody`. +2. Inside the `.cody` folder, create a file named `ignore`. +3. In the `ignore` file, specify the files or folders you want to ignore. + +The `.codyignore` file works similarly to a `.gitignore` file. If you want to ignore a file named `secret.json`, you would add `secret.json` to your `.codyignore` file. If you're going to ignore a folder called `lib/shared`, you would add `lib/shared/` to your `.codyignore` file. + +Once a file or folder is added to the `.codyignore` file, Cody will no longer provide autocomplete suggestions for that file or folder, and it will not appear in your chat results. diff --git a/docs/cody/capabilities/index.mdx b/docs/cody/capabilities/index.mdx index b933f11ec..180977092 100644 --- a/docs/cody/capabilities/index.mdx +++ b/docs/cody/capabilities/index.mdx @@ -10,6 +10,7 @@ Cody offers a rich set of capabilities and features that help you write better c - Autocomplete: Suggests code completions as you type, utilizing context from your code, open files, and file history - Commands & Custom Commands: Provide predefined, reusable prompts for common actions, such as documenting code, explaining code, generating unit tests, and identifying code smells - Debug code: Helps you with identifying and fixing code errors and bugs. +- Cody Ignore: Helps you ignore selected files or folders from chat and autocomplete result Learn more about each by exploring their respective documentation: @@ -23,4 +24,6 @@ Learn more about each by exploring their respective documentation: + + diff --git a/docs/cody/core-concepts/index.mdx b/docs/cody/core-concepts/index.mdx index 761b2ef2f..ab7e671da 100644 --- a/docs/cody/core-concepts/index.mdx +++ b/docs/cody/core-concepts/index.mdx @@ -12,4 +12,5 @@ + diff --git a/docs/cody/index.mdx b/docs/cody/index.mdx index 1680203c0..00b6d7cab 100644 --- a/docs/cody/index.mdx +++ b/docs/cody/index.mdx @@ -54,6 +54,10 @@ Cody's main features include: Debug code Cody can debug your code in the editor and also helps you identify code smells + + Cody Ignore + Cody can ignore selected files or folders from chat and autocomplete results + diff --git a/src/data/navigation.ts b/src/data/navigation.ts index ed464d4d3..89935a1ac 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -48,6 +48,7 @@ export const navigation: NavigationItem[] = [ { title: "Autocomplete", href: "/cody/capabilities/autocomplete", }, { title: "Commands", href: "/cody/capabilities/commands", }, { title: "Debug Code", href: "/cody/capabilities/debug-code", }, + { title: "Cody Ignore", href: "/cody/capabilities/ignore-context", }, ] }, {