Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Run `npm run build` to generate the release artifacts:
|--------|-------------|
| `dist/skills/<id>.zip` | Per-skill bundles (SKILL.md + references + shared docs) |
| `dist/skills/manifest.json` | Versioned manifest of every bundled skill and its download URL. It ships inside `skills-mcp-resources.zip`, not as its own release asset |
| `dist/skills/skill-menu.json` | Category groupings and `cliEntries` — the wizard's command lookup table. Each skill entry and bundle variant carries `title`, `description` and `tags`, and a bundle's own entry carries `tags` only; the tags add `framework:<framework>` for the framework it serves, its `group` and (when set) `default` to the skill's own |
| `dist/skills/skill-menu.json` | Category groupings and `cliEntries` — the wizard's command lookup table. Each skill entry and bundle variant carries `title`, `description` and `tags`, and a bundle's own entry carries `tags` only; the tags add `framework:<framework>` for the framework it serves, a `key:value` tag for each other `match` key, its `group` and (when set) `default` to the skill's own |
| `dist/agents/agent-menu.json` | Orchestrator flows and the task prompts in each one |
| `dist/skills-mcp-resources.zip` | One bundle of `manifest.json` and every skill ZIP, for the MCP server |

Expand All @@ -99,6 +99,36 @@ The wizard fetches `skill-menu.json` and `agent-menu.json` from the latest
release and downloads the per-skill ZIPs on demand. The MCP server fetches
`skills-mcp-resources.zip`.

### The variant table

`context/skills/integration/config.yaml` is the variant table: one row per
framework variant, and the build turns each row into one pack,
`integration-<variant>.zip`.

| Key | Meaning |
|-----|---------|
| `framework`, `default` | The detection id the row serves, and whether it is its framework's default |
| `match` | The trait values the pack is written for, published as `key:value` menu tags. A key is a trait name as the wizard spells it. `frameworkVariant` is the id the wizard's framework config reports, such as `pages-router`. A row with no `frameworkVariant` serves every value its framework's other rows do not name |
| `docs_urls` | The integration pages, written to `references/` and listed in `SKILL.md` |
| `docs` | Each other product's pages for the variant, written to `references/<product>/`. `SKILL.md` does not list them |
| `gaps` | The products a row has no pages for. The build fails when a row neither lists a product in `products` nor names it here |

Each pack carries a `variant.json` at its root with the row as built: its
`match` keys, its rules file, and each product's pages with their titles.
`integration` is the product for the row's own `docs_urls`.

A row's `docs` are that framework's own pages for a product. Pages a step
shares across every framework are the step skill's `shared_docs`, not a row's.
A run picks a step skill by framework and takes that family's default, so a
framework's default row lists the pages a run on that framework reads today.

A page is written under the last part of its URL, such as `next-js.md`. When
two pages of one folder share that part, each takes its parent part too:
`error-tracking/installation/python.md` and `libraries/python.md` are written
as `installation-python.md` and `libraries-python.md`. This holds for every
skill's pages. The build fails when two pages of a folder would still be
written under one name, since the second would replace the first.

### Manifest structure

The manifest describes the built skills — one resource per skill, with `id`,
Expand Down
Loading
Loading