Skip to content

Commit 86f8c99

Browse files
committed
Update docs to allow any file extension for rules.
It was already the case that there was no restriction on the extension of rules files. Just updating the docs to reflect that.
1 parent b6b58a5 commit 86f8c99

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/configuration.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Prompts can use variables like `$ARGS`, `$ARG1`, `ARG2`, to replace in the promp
8686

8787
A `$XDG_CONFIG_HOME/eca/commands` or `~/.config/eca/commands` folder containing `.md` files with the custom command prompt.
8888

89-
`~/.config/eca/commands/check-performance.mdc`
89+
`~/.config/eca/commands/check-performance.md`
9090
```markdown
9191
Check for performance issues in $ARG1 and optimize if needed.
9292
```
@@ -104,7 +104,8 @@ Prompts can use variables like `$ARGS`, `$ARG1`, `ARG2`, to replace in the promp
104104
## Rules
105105

106106
Rules are contexts that are passed to the LLM during a prompt and are useful to tune prompts or LLM behavior.
107-
Rules are Multi-Document context files (`.mdc`) and the following metadata is supported:
107+
Rules are text files (typically `.md` or `.mdc`, but any format works) with the following
108+
optional metadata:
108109

109110
- `description`: a description used by LLM to decide whether to include this rule in context, absent means always include this rule.
110111
- `globs`: list of globs separated by `,`. When present the rule will be applied only when files mentioned matches those globs.
@@ -113,9 +114,9 @@ There are 3 possible ways to configure rules following this order of priority:
113114

114115
=== "Project file"
115116

116-
A `.eca/rules` folder from the workspace root containing `.mdc` files with the rules.
117+
A `.eca/rules` folder from the workspace root containing `.md` files with the rules.
117118

118-
`.eca/rules/talk_funny.mdc`
119+
`.eca/rules/talk_funny.md`
119120
```markdown
120121
---
121122
description: Use when responding anything
@@ -126,7 +127,7 @@ There are 3 possible ways to configure rules following this order of priority:
126127

127128
=== "Global file"
128129

129-
A `$XDG_CONFIG_HOME/eca/rules` or `~/.config/eca/rules` folder containing `.mdc` files with the rules.
130+
A `$XDG_CONFIG_HOME/eca/rules` or `~/.config/eca/rules` folder containing `.md` files with the rules.
130131

131132
`~/.config/eca/rules/talk_funny.mdc`
132133
```markdown
@@ -139,11 +140,11 @@ There are 3 possible ways to configure rules following this order of priority:
139140

140141
=== "Config"
141142

142-
Just add toyour config the `:rules` pointing to `.mdc` files that will be searched from the workspace root if not an absolute path:
143+
Just add toyour config the `:rules` pointing to `.md` files that will be searched from the workspace root if not an absolute path:
143144

144145
```javascript
145146
{
146-
"rules": [{"path": "my-rule.mdc"}]
147+
"rules": [{"path": "my-rule.md"}]
147148
}
148149
```
149150

0 commit comments

Comments
 (0)