Skip to content

Commit 58e7727

Browse files
authored
docs(repo): reorganize documentation structure (#131)
* docs(repo): reorganize documentation structure Signed-off-by: Vatche Isahagian <vatchei@ibm.com> * docs(repo): align doc examples with integrations Signed-off-by: Vatche Isahagian <vatchei@ibm.com> --------- Signed-off-by: Vatche Isahagian <vatchei@ibm.com>
1 parent 8e6c76d commit 58e7727

21 files changed

Lines changed: 136 additions & 88 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,

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## How to contribute to ALTK‑Evolve
1+
## How to Contribute to Evolve
22

3-
ALTK‑Evolve welcomes external contributions of all kinds. Whether you are fixing bugs, improving existing functionality, or adding new evolution-focused capabilities, we’re glad to work with you.
3+
Evolve welcomes external contributions of all kinds. Whether you are fixing bugs, improving existing functionality, or adding new evolution-focused capabilities, we’re glad to work with you.
44

55
### Did you find a bug?
66

@@ -9,7 +9,7 @@ ALTK‑Evolve welcomes external contributions of all kinds. Whether you are fixi
99
### Types of contributions
1010

1111
* Fixing bugs
12-
* Improving existing ALTK‑Evolve components
12+
* Improving existing Evolve components
1313
* Adding new components or evolution strategies
1414
* Improving documentation, examples, or tests
1515

@@ -54,9 +54,9 @@ Or:
5454
pre-commit run --all-files
5555
```
5656

57-
### Adding new components to ALTK‑Evolve
57+
### Adding new components to Evolve
5858

59-
ALTK‑Evolve builds on Agent Lifecycle Toolkit concepts with a focus on agent evolution, adaptation, and improvement over time.
59+
Evolve builds on Agent Lifecycle Toolkit concepts with a focus on agent evolution, adaptation, and improvement over time.
6060

6161
1. Identify the evolution purpose of your component.
6262
2. Add a new package under the appropriate module.

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Prerequisites:
3232

3333
```bash
3434
git clone <repository_url>
35-
cd evolve
35+
cd altk-evolve
3636
uv venv --python=3.12 && source .venv/bin/activate
3737
uv sync
3838
```
@@ -44,7 +44,7 @@ For direct OpenAI usage:
4444
export OPENAI_API_KEY=sk-...
4545
```
4646

47-
For LiteLLM proxy usage and model selection (including global fallback via `EVOLVE_MODEL_NAME`), see [CONFIGURATION.md](CONFIGURATION.md).
47+
For LiteLLM proxy usage and model selection (including global fallback via `EVOLVE_MODEL_NAME`), see [the configuration guide](docs/guides/configuration.md).
4848

4949
### Running the MCP Server & UI
5050

@@ -102,7 +102,7 @@ Evolve automatically tracks the origin of every guideline it generates or stores
102102
- `creation_mode`: Identifies how the tip was created (`auto-phoenix` via trace observability, `auto-mcp` via trajectory saving tools, or `manual`).
103103
- `source_task_id`: The ID of the original trace or task that inspired the tip, providing full audibility.
104104

105-
See the [Low-Code Tracing Guide](docs/LOW_CODE_TRACING.md#6-understanding-tip-provenance-metadata) for more details.
105+
See the [Low-Code Tracing Guide](docs/guides/low-code-tracing.md#6-understanding-tip-provenance-metadata) for more details.
106106

107107

108108
## Community & Feedback
@@ -115,11 +115,13 @@ If you’re experimenting with Evolve or exploring on‑the‑job learning for a
115115

116116
## Documentation
117117

118-
- [EVOLVE_LITE.md](EVOLVE_LITE.md) - Lightweight mode via Claude Code plugin (no infra required)
119-
- [CONFIGURATION.md](CONFIGURATION.md) - Detailed configuration options
120-
- [POLICIES.md](docs/POLICIES.md) - Policy support and schema
121-
- [CLI.md](CLI.md) - Command-line interface documentation
122-
- [CLAUDE_CODE_DEMO.md](CLAUDE_CODE_DEMO.md) - Claude Code demo walkthrough
118+
- [Documentation Home](docs/index.md) - Overview of guides, reference docs, and tutorials
119+
- [Installation](docs/installation/index.md) - Setup instructions for supported platforms
120+
- [Configuration](docs/guides/configuration.md) - Environment variables and backend options
121+
- [CLI Reference](docs/reference/cli.md) - Command-line interface documentation
122+
- [Evolve Lite](docs/integrations/evolve-lite.md) - Lightweight Claude Code plugin mode
123+
- [Claude Code Demo](docs/tutorials/claude-code-demo.md) - End-to-end demo walkthrough
124+
- [Policies](docs/reference/policies.md) - Policy support and schema
123125

124126
## Development
125127

@@ -150,7 +152,7 @@ The test suite is organized into 4 cleanly isolated tiers depending on infrastru
150152
```bash
151153
uv run pytest -m e2e --run-e2e
152154
```
153-
*(See [docs/LOW_CODE_TRACING.md](docs/LOW_CODE_TRACING.md#end-to-end-verification) for more details).*
155+
*(See [the Low-Code Tracing Guide](docs/guides/low-code-tracing.md#end-to-end-verification) for more details).*
154156

155157
5. **LLM Evaluation Tests**
156158
Tests needing active LLM inference to test resolution pipelines (requires LLM API keys).

SAVE_SKILL_DESIGN.md renamed to docs/archive/save-session-as-skill-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ When the skill is invoked, the session history is already available in the conte
279279
- **Agent responses**: All assistant messages and outputs
280280

281281
**No External Fetching Required**:
282-
- No need to call Phoenix or extract_trajectories.py
282+
- No need to call Phoenix or `scripts/extract_trajectories.py`
283283
- No need to check environment variables
284284
- Context is provided automatically when skill is invoked
285285

@@ -816,4 +816,4 @@ if __name__ == "__main__":
816816
1. ✅ Design approved by user
817817
2. ✅ Trajectory access method confirmed (use session context)
818818
3. Create the actual save-session-as-skill SKILL.md
819-
4. Test the skill with the current session as an example
819+
4. Test the skill with the current session as an example

docs/examples/hello_world/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ uv init
1414
```
1515

1616
## Step 2: Install Evolve
17-
Install Evolve by following the [installation instructions](../../installation), or run:
17+
Install Evolve by following the [installation instructions](../../installation/index.md), or run:
1818
```bash
19-
curl -fsSL https://raw.githubusercontent.com/AgentToolkit/evolve/main/platform-integrations/install.sh | bash -s -- install --platform bob --mode lite
19+
curl -fsSL https://raw.githubusercontent.com/AgentToolkit/altk-evolve/main/platform-integrations/install.sh | bash -s -- install --platform bob --mode lite
2020
```
2121
## Step 3: Project Setup
2222
Open the project directory in IBM Bob IDE, and switch Bob's mode to `Evolve Lite`
@@ -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.
File renamed without changes.
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Extract Trajectories from Arize Phoenix
22

3-
A Python tool to extract agent trajectories from Arize Phoenix traces and convert them to OpenAI chat completion message format.
3+
A Python utility at `scripts/extract_trajectories.py` for extracting agent trajectories from Arize Phoenix traces and converting them to OpenAI chat completion message format.
44

55
## Features
66

@@ -23,25 +23,25 @@ A Python tool to extract agent trajectories from Arize Phoenix traces and conver
2323

2424
```bash
2525
# Get recent trajectories as JSON (pretty-printed)
26-
python3 extract_trajectories.py --limit 100 --pretty
26+
python3 scripts/extract_trajectories.py --limit 100 --pretty
2727

2828
# Get a specific trace by ID
29-
python3 extract_trajectories.py --trace-id a67264f4375a60a1ac26ef3061c7352d --pretty
29+
python3 scripts/extract_trajectories.py --trace-id a67264f4375a60a1ac26ef3061c7352d --pretty
3030

3131
# Human-readable text format
32-
python3 extract_trajectories.py --text --trace-id a67264f4375a60a1ac26ef3061c7352d
32+
python3 scripts/extract_trajectories.py --text --trace-id a67264f4375a60a1ac26ef3061c7352d
3333

3434
# Include failed/error spans
35-
python3 extract_trajectories.py --include-errors --pretty
35+
python3 scripts/extract_trajectories.py --include-errors --pretty
3636

3737
# Keep system reminders (don't clean)
38-
python3 extract_trajectories.py --no-clean --pretty
38+
python3 scripts/extract_trajectories.py --no-clean --pretty
3939

4040
# Save to file
41-
python3 extract_trajectories.py --limit 100 -o trajectories.json --pretty
41+
python3 scripts/extract_trajectories.py --limit 100 -o trajectories.json --pretty
4242

4343
# Custom Phoenix URL
44-
python3 extract_trajectories.py --url http://localhost:8080 --pretty
44+
python3 scripts/extract_trajectories.py --url http://localhost:8080 --pretty
4545
```
4646

4747
### CLI Options
@@ -60,7 +60,7 @@ python3 extract_trajectories.py --url http://localhost:8080 --pretty
6060
### As a Library
6161

6262
```python
63-
from extract_trajectories import (
63+
from scripts.extract_trajectories import (
6464
get_trajectories,
6565
get_trajectory_by_trace_id,
6666
format_trajectory_as_text
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Two entity types are stored:
145145

146146
```bash
147147
# Sync every hour
148-
0 * * * * cd /path/to/evolve && uv run evolve sync phoenix --limit 100
148+
0 * * * * cd /path/to/altk-evolve && uv run evolve sync phoenix --limit 100
149149
```
150150

151151
### Systemd Timer
@@ -157,7 +157,7 @@ Description=Evolve Phoenix Sync
157157

158158
[Service]
159159
Type=oneshot
160-
WorkingDirectory=/path/to/evolve
160+
WorkingDirectory=/path/to/altk-evolve
161161
ExecStart=/path/to/uv run evolve sync phoenix
162162
Environment=PHOENIX_URL=http://localhost:6006
163163
Environment=EVOLVE_NAMESPACE_ID=production

docs/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,27 @@ Evolve is a system designed to help agents improve over time by learning from th
1010
- **Trajectory Analysis**: Automatically analyzes agent trajectories to generate guidelines and best practices.
1111
- **Milvus Integration**: Uses Milvus (or Milvus Lite) for efficient vector storage and retrieval.
1212

13+
## Start Here
14+
15+
- [Installation](installation/index.md): Set up Evolve on Bob or Claude Code.
16+
- [Configuration](guides/configuration.md): Configure models, backends, and environment variables.
17+
- [CLI Reference](reference/cli.md): Manage namespaces, entities, and sync jobs from the command line.
18+
19+
## Guides
20+
21+
- [Low-Code Tracing](guides/low-code-tracing.md): Instrument agents with Phoenix and verify end-to-end tracing.
22+
- [Phoenix Sync](guides/phoenix-sync.md): Pull trajectories from Phoenix and generate stored guidelines.
23+
- [Extract Trajectories](guides/extract-trajectories.md): Export Phoenix traces into an OpenAI-style message format.
24+
25+
## Integrations and Tutorials
26+
27+
- [Evolve Lite](integrations/evolve-lite.md): Lightweight Claude Code integration with local entity storage.
28+
- [Claude Code Demo](tutorials/claude-code-demo.md): Run the filesystem demo with Claude Code and the Evolve MCP server.
29+
- [Hello World with IBM Bob](examples/hello_world/index.md): A simple Bob walkthrough that shows how memory gets learned.
30+
31+
## Reference
32+
33+
- [Policies](reference/policies.md): Structured policy entities and how to retrieve them with MCP tools.
34+
1335
## Architecture
14-
![Screenshot](assets/architecture.png)
36+
![Architecture](assets/architecture.png)

0 commit comments

Comments
 (0)