Skip to content

Commit 955e146

Browse files
committed
docs: flatten registries and skills to the same level across all config contexts for consistency
1 parent 51b6390 commit 955e146

3 files changed

Lines changed: 32 additions & 47 deletions

File tree

docs/ai/design/feature-custom-skill-registries.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,17 @@ graph TD
3030
**What data do we need to manage?**
3131

3232
- Global config (new or extended):
33-
- `skills.registries` (map of `registryId -> gitUrl`)
33+
- `registries` (map of `registryId -> gitUrl`)
3434
- Registry JSON (existing):
3535
- `registries` map of registry IDs to Git URLs
3636

3737
Example global config snippet:
3838

3939
```json
4040
{
41-
"skills": {
42-
"registries": {
43-
"my-org/skills": "git@github.com:my-org/skills.git",
44-
"me/personal-skills": "https://github.com/me/personal-skills.git"
45-
}
41+
"registries": {
42+
"my-org/skills": "git@github.com:my-org/skills.git",
43+
"me/personal-skills": "https://github.com/me/personal-skills.git"
4644
}
4745
}
4846
```

web/content/docs/11-configuration-file.md

Lines changed: 25 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,13 @@ Use this page as a reference for fields inside `.ai-devkit.json`. In most cases,
3232
"memory": {
3333
"path": ".ai-devkit/memory.db"
3434
},
35-
"skills": {
36-
"registries": {
37-
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git"
38-
},
39-
"installed": [
40-
{ "registry": "codeaholicguy/ai-devkit", "name": "debug" },
41-
{ "registry": "codeaholicguy/ai-devkit", "name": "dev-lifecycle" }
42-
]
35+
"registries": {
36+
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git"
4337
},
38+
"skills": [
39+
{ "registry": "codeaholicguy/ai-devkit", "name": "debug" },
40+
{ "registry": "codeaholicguy/ai-devkit", "name": "dev-lifecycle" }
41+
],
4442
"mcpServers": {
4543
"memory": {
4644
"transport": "stdio",
@@ -146,43 +144,36 @@ Stages of the software development lifecycle that AI DevKit creates document tem
146144

147145
**Read by:** `ai-devkit memory store`, `ai-devkit memory search`, `ai-devkit memory update`
148146

149-
#### `skills`
147+
#### `registries`
150148

151-
- **Type:** object or array
149+
- **Type:** `Record<string, string>`
152150
- **Optional**
153151

154-
The `skills` field tracks installed skills and custom registries. It supports two formats:
155-
156-
**Object format (recommended):**
157-
158-
If you edit this field manually, use the object format. The array format is supported only for backward compatibility.
152+
Maps custom registry IDs (e.g., `owner/repo`) to Git URLs. These are merged with the built-in registries when resolving skills. Project-level registries take priority over global registries, which take priority over built-in defaults.
159153

160154
```json
161-
"skills": {
162-
"registries": {
163-
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git"
164-
},
165-
"installed": [
166-
{ "registry": "codeaholicguy/ai-devkit", "name": "debug" }
167-
]
155+
"registries": {
156+
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git",
157+
"my-org/custom-skills": "https://github.com/my-org/custom-skills.git"
168158
}
169159
```
170160

171-
| Sub-field | Type | Description |
172-
|-----------|------|-------------|
173-
| `registries` | `Record<string, string>` | Maps registry IDs (e.g., `owner/repo`) to Git URLs. Merged with built-in registries. |
174-
| `installed` | array of `{ registry, name }` | List of installed skills. Duplicates are automatically deduplicated. |
161+
**Set by:** `ai-devkit init --template` or by editing `.ai-devkit.json` directly
162+
163+
#### `skills`
164+
165+
- **Type:** array of `{ registry, name }`
166+
- **Optional**
175167

176-
**Array format (legacy):**
168+
List of installed skills. Duplicates are automatically deduplicated.
177169

178170
```json
179171
"skills": [
180-
{ "registry": "codeaholicguy/ai-devkit", "name": "debug" }
172+
{ "registry": "codeaholicguy/ai-devkit", "name": "debug" },
173+
{ "registry": "codeaholicguy/ai-devkit", "name": "dev-lifecycle" }
181174
]
182175
```
183176

184-
Both formats are accepted. The array format is automatically normalized to the object format.
185-
186177
**Modified by:** `ai-devkit skill add`, `ai-devkit skill remove`, `ai-devkit skill update`, `ai-devkit init --built-in`
187178

188179
#### `mcpServers`
@@ -248,11 +239,9 @@ The global config file has a smaller scope than the project config. It only supp
248239

249240
```json
250241
{
251-
"skills": {
252-
"registries": {
253-
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git",
254-
"my-org/custom-skills": "https://github.com/my-org/custom-skills.git"
255-
}
242+
"registries": {
243+
"codeaholicguy/ai-devkit": "https://github.com/codeaholicguy/ai-devkit.git",
244+
"my-org/custom-skills": "https://github.com/my-org/custom-skills.git"
256245
}
257246
}
258247
```
@@ -261,7 +250,7 @@ Use the global config when you want the same custom skill registries available i
261250

262251
Global registries are merged with any project-level registries. If the same registry ID exists in both, the project-level entry takes priority.
263252

264-
The global config does **not** support `environments`, `phases`, `paths`, `memory`, or `mcpServers`.
253+
The global config does **not** support `environments`, `phases`, `paths`, `memory`, `skills`, or `mcpServers`.
265254

266255
## Which Commands Use the Config
267256

web/content/docs/7-skills.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -349,11 +349,9 @@ You can add your own registries by editing the global AI DevKit config at `~/.ai
349349

350350
```json
351351
{
352-
"skills": {
353-
"registries": {
354-
"my-org/skills": "git@gitlab.com:my-org/skills.git",
355-
"me/personal-skills": "https://github.com/me/personal-skills.git"
356-
}
352+
"registries": {
353+
"my-org/skills": "git@gitlab.com:my-org/skills.git",
354+
"me/personal-skills": "https://github.com/me/personal-skills.git"
357355
}
358356
}
359357
```

0 commit comments

Comments
 (0)