Skip to content

Commit 1f12655

Browse files
committed
docs(repo): align doc examples with integrations
Signed-off-by: Vatche Isahagian <vatchei@ibm.com>
1 parent e212109 commit 1f12655

5 files changed

Lines changed: 46 additions & 37 deletions

File tree

.secrets.baseline

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"files": "^.secrets.baseline$|package-lock\\.json$",
44
"lines": null
55
},
6-
"generated_at": "2026-02-26T16:00:29Z",
6+
"generated_at": "2026-04-02T15:14:08Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -77,35 +77,35 @@
7777
}
7878
],
7979
"results": {
80-
"CONFIGURATION.md": [
80+
"README.md": [
8181
{
8282
"hashed_secret": "ec3810e10fb78db55ce38b9c18d1c3eb1db739e0",
8383
"is_secret": false,
8484
"is_verified": false,
85-
"line_number": 9,
85+
"line_number": 44,
8686
"type": "Secret Keyword",
8787
"verified_result": null
88-
},
88+
}
89+
],
90+
"docs/guides/configuration.md": [
8991
{
90-
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
92+
"hashed_secret": "ec3810e10fb78db55ce38b9c18d1c3eb1db739e0",
9193
"is_secret": false,
9294
"is_verified": false,
93-
"line_number": 18,
95+
"line_number": 9,
9496
"type": "Secret Keyword",
9597
"verified_result": null
96-
}
97-
],
98-
"README.md": [
98+
},
9999
{
100-
"hashed_secret": "ec3810e10fb78db55ce38b9c18d1c3eb1db739e0",
100+
"hashed_secret": "11fa7c37d697f30e6aee828b4426a10f83ab2380",
101101
"is_secret": false,
102102
"is_verified": false,
103-
"line_number": 36,
103+
"line_number": 18,
104104
"type": "Secret Keyword",
105105
"verified_result": null
106106
}
107107
],
108-
"README_extract_trajectories.md": [
108+
"docs/guides/extract-trajectories.md": [
109109
{
110110
"hashed_secret": "48ae8db8c64fbf47ec3f8eec6f31f3a5b88594d2",
111111
"is_secret": false,
@@ -123,7 +123,7 @@
123123
"verified_result": null
124124
}
125125
],
126-
"README_phoenix_sync.md": [
126+
"docs/guides/phoenix-sync.md": [
127127
{
128128
"hashed_secret": "ec3810e10fb78db55ce38b9c18d1c3eb1db739e0",
129129
"is_secret": false,

docs/examples/hello_world/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ At this point, Bob will correct itself and eventually run `uv sync` and correctl
4242
Bob should then run some Evolve Lite skills to save the learned correction into memory.
4343
If it does not, the `/evolve:learn` command can be used to manually run the skill.
4444

45-
In the future, Bob should remember via Evolve-Lite skills that `uv` is used for this project and not make the same mistake. This can be tested in this toy project by deleting the `.venv` and `uv.lock` folder and trying the same utterance again.
45+
In the future, Bob should remember via Evolve-Lite skills that `uv` is used for this project and not make the same mistake. This can be tested in this toy project by deleting the `.venv` directory and the `uv.lock` file and trying the same utterance again.

docs/installation/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ curl -fsSL https://raw.githubusercontent.com/AgentToolkit/altk-evolve/v1.0.5/pla
1515
```
1616
### Install Script Usage
1717
```bash
18-
./install.sh install --platform {bob,claude,all} --mode {lite,full} [--dry-run]
18+
./install.sh install --platform {bob,roo,claude,all} --mode {lite,full} [--dry-run]
1919
```
2020

2121
| Platform | Description |
2222
|-----------|-------------|
2323
| `all` | Install all platforms |
2424
| `bob` | IBM Bob |
25+
| `roo` | Roo Code |
2526
| `claude` | Claude Code |
2627

2728
| Mode | Description |

docs/integrations/evolve-lite.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Evolve Lite
22

3-
Evolve Lite is a lightweight mode that runs as a Claude Code plugin — no vector store, no MCP servers, no API keys required. It stores entities as plain JSON in your project directory and uses Claude Code's built-in hooks to inject them automatically.
3+
Evolve Lite is a lightweight mode that runs as a Claude Code plugin — no vector store, no MCP servers, no API keys required. It stores entities as Markdown files with YAML frontmatter under `.evolve/entities/` in your project directory and uses Claude Code's built-in hooks to inject them automatically.
44

55
## Prerequisites
66

@@ -31,11 +31,11 @@ claude plugin list
3131

3232
Evolve Lite has two halves:
3333

34-
1. **Learn** — You invoke `/evolve:learn` at the end of a conversation. The plugin analyzes what happened and extracts reusable entities (preferences, strategies, recovery patterns) into `.evolve/entities.json`.
34+
1. **Learn** — You invoke `/evolve:learn` at the end of a conversation. The plugin analyzes what happened, produces an entity JSON payload, and saves each entity as a Markdown file under `.evolve/entities/`.
3535

3636
2. **Recall** — On every subsequent prompt, a `UserPromptSubmit` hook automatically loads stored entities and injects them into the conversation context. Claude applies whichever entities are relevant to the current task.
3737

38-
No external services are involved. The entire loop is a JSON file and two Python scripts.
38+
No external services are involved. The entire loop is a directory of entity files and two Python scripts.
3939

4040
## Example Walkthrough
4141

@@ -79,7 +79,7 @@ Claude: I've extracted the following entities from this conversation:
7979
}
8080
8181
Added 1 new entity(ies). Total: 1
82-
Entities stored in: /path/to/project/.evolve/entities.json
82+
Entities stored in: /path/to/project/.evolve/entities
8383
```
8484

8585
### Session 2 — Preference is applied automatically
@@ -117,7 +117,7 @@ Then run a task to extract metadata from an image:
117117
just trace=true learn=true sandbox-prompt 'where was the photo @sample.jpg taken. use exif metadata'
118118
```
119119

120-
When you run the above, you will see that the agent hits some dead ends (exiftool not found, Pillow not installed), and that it learns guidelines to avoid them in the future (see `demo/workspace/.evolve/entities.json`).
120+
When you run the above, you will see that the agent hits some dead ends (exiftool not found, Pillow not installed), and that it learns guidelines to avoid them in the future (see `demo/workspace/.evolve/entities/`).
121121

122122
Run the same task again in a new session:
123123

@@ -197,7 +197,7 @@ Claude: I've extracted the following entities from this conversation:
197197
}
198198
199199
Added 2 new entity(ies). Total: 2
200-
Entities stored in: /workspace/.evolve/entities.json
200+
Entities stored in: /workspace/.evolve/entities
201201
```
202202

203203
### Session 2 — No more dead ends
@@ -232,22 +232,30 @@ The agent skipped both `exiftool` and `Pillow` entirely — it went straight to
232232

233233
## Entities Storage
234234

235-
Entities live in `.evolve/entities.json` in the project root:
236-
237-
```json
238-
{
239-
"entities": [
240-
{
241-
"content": "Use Python stdlib (struct module) to manually parse JPEG EXIF/GPS metadata when no external tools are available",
242-
"rationale": "In sandboxed environments, neither system tools (exiftool) nor third-party libraries (PIL/Pillow) may be installed. Python stdlib is always available.",
243-
"category": "strategy",
244-
"trigger": "When extracting EXIF or GPS metadata from images in containerized or sandboxed environments"
245-
}
246-
]
247-
}
235+
Entities live in `.evolve/entities/` in the project root, organized into type-based subdirectories:
236+
237+
```text
238+
.evolve/entities/
239+
strategy/
240+
use-python-stdlib-struct-module-to-manually-parse-jpeg-exif-gps.md
241+
```
242+
243+
Each entity file uses Markdown with YAML frontmatter:
244+
245+
```markdown
246+
---
247+
type: strategy
248+
trigger: When extracting EXIF or GPS metadata from images in containerized or sandboxed environments
249+
---
250+
251+
Use Python stdlib (struct module) to manually parse JPEG EXIF/GPS metadata when no external tools are available
252+
253+
## Rationale
254+
255+
In sandboxed environments, neither system tools (exiftool) nor third-party libraries (PIL/Pillow) may be installed. Python stdlib is always available.
248256
```
249257

250-
Override the storage location with the `EVOLVE_ENTITIES_FILE` environment variable.
258+
Override the storage location with the `EVOLVE_ENTITIES_DIR` environment variable.
251259

252260
## Tradeoffs
253261

@@ -267,7 +275,7 @@ But it has a number of limitations:
267275

268276
| Capability | Evolve Lite | Full Evolve |
269277
|------------|-------------|-------------|
270-
| Entity storage | JSON file | Milvus vector store |
278+
| Entity storage | Markdown files in `.evolve/entities/` | Milvus vector store |
271279
| Retrieval | All entities injected via hooks | Semantic search via MCP |
272280
| Conflict resolution | Append-only | LLM-based merging + garbage collection |
273281
| Trajectory analysis | Current session only (`/evolve:learn`) | Multi-session, automatic via MCP |

platform-integrations/claude/plugins/evolve-lite/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See the [Evolve Lite guide](../../../../docs/integrations/evolve-lite.md#example
5454
Manually invoke to extract entities from the current conversation:
5555
- Analyzes task, steps taken, successes and failures
5656
- Generates proactive entities (what to do, not what to avoid)
57-
- Outputs JSON for storage
57+
- Outputs JSON that the save script persists as entity files
5858

5959
### `/evolve:recall`
6060

0 commit comments

Comments
 (0)