Skip to content

Commit e593c74

Browse files
dvdksnclaude
andcommitted
docs: add kit spec changelog and fix kits-memory directory name
Add a Changelog section at the top of the kit spec reference noting the v0.32.0 field renames (memory -> agentContext, kind: agent -> kind: sandbox, agent: block -> sandbox: block), which are deprecated aliases that sbx kit validate warns on. Also fix the per-kit directory name: v0.32.0 renamed kits-memory/ to kits-agent-context/ (with automatic migration), which the docs had not been updated to reflect. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 2167dc4 commit e593c74

2 files changed

Lines changed: 26 additions & 6 deletions

File tree

content/manuals/ai/sandboxes/customize/kit-reference.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,26 @@ my-kit/
2727
└── workspace/
2828
```
2929

30+
## Changelog
31+
32+
Renamed fields are still accepted for backward compatibility, but
33+
`sbx kit validate` reports a deprecation warning for each, and a future
34+
release may stop accepting them. Update kits to the current names.
35+
36+
### v0.32.0
37+
38+
The following `spec.yaml` fields were renamed:
39+
40+
| Previous | Current |
41+
| -------------- | ---------------- |
42+
| `memory` | `agentContext` |
43+
| `kind: agent` | `kind: sandbox` |
44+
| `agent:` block | `sandbox:` block |
45+
46+
The per-kit directory was also renamed from `kits-memory/` to
47+
`kits-agent-context/`. An existing `kits-memory/` directory is migrated
48+
automatically the next time the sandbox starts.
49+
3050
## Top-level fields
3151

3252
```yaml
@@ -287,7 +307,7 @@ When several loaded kits declare `agentContext:` blocks, the content is split
287307
across files instead of being concatenated into the main one:
288308

289309
- Each kit's agent context is written to `<kit-name>.md` in a sibling
290-
`kits-memory/` directory next to the main memory file.
310+
`kits-agent-context/` directory next to the main memory file.
291311
- The main memory file gets a `## Kits` section listing every kit with
292312
a pointer to its file. The section is delimited by
293313
`<!-- sbx:kits-section start -->` and `<!-- sbx:kits-section end -->`

content/manuals/ai/sandboxes/customize/kits.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -214,14 +214,14 @@ which determines the memory file's name.
214214

215215
When more than one loaded kit declares an `agentContext:` block, each kit's
216216
content is written to its own `<kit-name>.md` file under a sibling
217-
`kits-memory/` directory. The main memory file gets a `## Kits` section
218-
that points to each kit file:
217+
`kits-agent-context/` directory. The main memory file gets a `## Kits`
218+
section that points to each kit file:
219219

220220
```text
221221
/Users/you/
222-
├── myproject/ # workspace
223-
├── AGENTS.md # main memory file with a "## Kits" index
224-
└── kits-memory/
222+
├── myproject/ # workspace
223+
├── AGENTS.md # main memory file with a "## Kits" index
224+
└── kits-agent-context/
225225
├── ruff-lint.md
226226
├── vale.md
227227
└── git-ssh-sign.md

0 commit comments

Comments
 (0)