Skip to content

Commit 18c15fa

Browse files
authored
Merge pull request #72 from bombaywalla/rule-file-extension-docs
Rule file extension docs
2 parents 1b7e2c3 + e2c04e7 commit 18c15fa

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/configuration.md

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

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

95-
`~/.config/eca/commands/check-performance.mdc`
95+
`~/.config/eca/commands/check-performance.md`
9696
```markdown
9797
Check for performance issues in $ARG1 and optimize if needed.
9898
```
@@ -110,7 +110,8 @@ Prompts can use variables like `$ARGS`, `$ARG1`, `ARG2`, to replace in the promp
110110
## Rules
111111

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

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

120121
=== "Project file"
121122

122-
A `.eca/rules` folder from the workspace root containing `.mdc` files with the rules.
123+
A `.eca/rules` folder from the workspace root containing `.md` files with the rules.
123124

124-
`.eca/rules/talk_funny.mdc`
125+
`.eca/rules/talk_funny.md`
125126
```markdown
126127
---
127128
description: Use when responding anything
@@ -132,9 +133,9 @@ There are 3 possible ways to configure rules following this order of priority:
132133

133134
=== "Global file"
134135

135-
A `$XDG_CONFIG_HOME/eca/rules` or `~/.config/eca/rules` folder containing `.mdc` files with the rules.
136+
A `$XDG_CONFIG_HOME/eca/rules` or `~/.config/eca/rules` folder containing `.md` files with the rules.
136137

137-
`~/.config/eca/rules/talk_funny.mdc`
138+
`~/.config/eca/rules/talk_funny.md`
138139
```markdown
139140
---
140141
description: Use when responding anything
@@ -145,11 +146,11 @@ There are 3 possible ways to configure rules following this order of priority:
145146

146147
=== "Config"
147148

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

150151
```javascript
151152
{
152-
"rules": [{"path": "my-rule.mdc"}]
153+
"rules": [{"path": "my-rule.md"}]
153154
}
154155
```
155156

0 commit comments

Comments
 (0)