Skip to content

Commit f1d034c

Browse files
Merge pull request #6102 from continuedev/pe/rule-docs-update
docs: update rule properties
2 parents a5f8b8a + 2aff43b commit f1d034c

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,9 @@ Rules blocks can be simple text, written in YAML configuration files, or as Mark
6363

6464
- `name` (**required** for YAML): A display name/title for the rule
6565
- `globs` (optional): When files are provided as context that match this glob pattern, the rule will be included. This can be either a single pattern (e.g., `"**/*.{ts,tsx}"`) or an array of patterns (e.g., `["src/**/*.ts", "tests/**/*.ts"]`).
66+
- `description` (optional): A description for the rule. Agents may read this description when `alwaysApply` is false to determine whether the rule should be pulled into context.
6667
- `alwaysApply`: true - Always include the rule, regardless of file context
67-
- `alwaysApply`: false - Only include if globs exist AND match file context
68+
- `alwaysApply`: false - Included if globs exist AND match file context, or the agent decides to pull the rule into context based on it's description
6869
- `alwaysApply`: undefined - Default behavior: include if no globs exist OR globs exist and match
6970

7071
<Tabs groupId="rules-example">

0 commit comments

Comments
 (0)