Skip to content

Commit fa48d50

Browse files
committed
Update README documentation to clarify terminology and standardize prompt examples
1 parent 4990c7d commit fa48d50

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ Code Web Chat (CWC) is a free and open-source, privacy-first **AI coding toolkit
3636

3737
## Introduction
3838

39-
In the world of AI coding, agents like Claude Code or Codex rely on "Function Calling" (where the AI asks "the harness" to read a file, waits for the tool to respond, then reads another). CWC flips this by letting you provide context files upfront to let you quickly iterate on instructions without polluting the context window.
39+
In the world of AI coding, agents like Claude Code or Codex rely on "Function Calling" (where the AI asks "the harness" to read a file, waits for the tool to respond, then reads another). CWC flips this by letting you provide context files upfront for fast iterations on instructions without polluting the context window.
4040

4141
**Prompt types:**
4242

4343
<details>
4444
<summary>Edit context</summary>
4545

4646
```
47-
<files>[the selected files]</files>
48-
<system>[edit format (e.g. diff) instructions]</system>
47+
<files>[current file tree selection]</files>
48+
<system>[edit format instructions]</system>
4949
[user-typed prompt]
5050
```
5151

@@ -55,7 +55,7 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
5555
<summary>Ask about context</summary>
5656

5757
```
58-
<files>[the selected files]</files>
58+
<files>[current file tree selection]</files>
5959
[user-typed prompt]
6060
```
6161

@@ -66,12 +66,12 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
6666

6767
```
6868
<files>
69-
[the selected files]
69+
[current file tree selection]
7070
<file path="[active file]">
7171
[code before cursor]<missing_text>[user-typed prompt]</missing_text>[code after cursor]
7272
</file>
7373
</files>
74-
[predefined instructions]
74+
[instructions for the missing text]
7575
```
7676

7777
</details>
@@ -80,9 +80,9 @@ In the world of AI coding, agents like Claude Code or Codex rely on "Function Ca
8080
<summary>Find relevant files</summary>
8181

8282
```
83-
<files>[the selected files]</files>
84-
<system>[output format]</system>
85-
[predefined instructions]
83+
<files>[current file tree selection]</files>
84+
<system>[output format instructions]</system>
85+
Find all files building modules of the following task's scope:
8686
[user-typed prompt]
8787
```
8888

0 commit comments

Comments
 (0)