diff --git a/docs/config.json b/docs/config.json index 9134108..ac5fc11 100644 --- a/docs/config.json +++ b/docs/config.json @@ -1,60 +1,64 @@ -{ - "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json", - "docSearch": { - "appId": "", - "apiKey": "", - "indexName": "tanstack-agents" - }, - "sections": [ - { - "label": "Getting Started", - "children": [ - { - "label": "Overview", - "to": "overview" - }, - { - "label": "Quick Start (Consumers)", - "to": "getting-started/quick-start-consumers" - }, - { - "label": "Quick Start (Maintainers)", - "to": "getting-started/quick-start-maintainers" - } - ] - }, - { - "label": "CLI Reference", - "children": [ - { - "label": "intent install", - "to": "cli/intent-install" - }, - { - "label": "intent list", - "to": "cli/intent-list" - }, - { - "label": "intent meta", - "to": "cli/intent-meta" - }, - { - "label": "intent scaffold", - "to": "cli/intent-scaffold" - }, - { - "label": "intent validate", - "to": "cli/intent-validate" - }, - { - "label": "intent setup-github-actions", - "to": "cli/intent-setup" - }, - { - "label": "intent stale", - "to": "cli/intent-stale" - } - ] - } - ] -} +{ + "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json", + "docSearch": { + "appId": "", + "apiKey": "", + "indexName": "tanstack-agents" + }, + "sections": [ + { + "label": "Getting Started", + "children": [ + { + "label": "Overview", + "to": "overview" + }, + { + "label": "Quick Start (Consumers)", + "to": "getting-started/quick-start-consumers" + }, + { + "label": "Quick Start (Maintainers)", + "to": "getting-started/quick-start-maintainers" + }, + { + "label": "Get Listed on the Registry", + "to": "registry" + } + ] + }, + { + "label": "CLI Reference", + "children": [ + { + "label": "intent install", + "to": "cli/intent-install" + }, + { + "label": "intent list", + "to": "cli/intent-list" + }, + { + "label": "intent meta", + "to": "cli/intent-meta" + }, + { + "label": "intent scaffold", + "to": "cli/intent-scaffold" + }, + { + "label": "intent validate", + "to": "cli/intent-validate" + }, + { + "label": "intent setup-github-actions", + "to": "cli/intent-setup" + }, + { + "label": "intent stale", + "to": "cli/intent-stale" + } + ] + } + ] +} diff --git a/docs/registry.md b/docs/registry.md new file mode 100644 index 0000000..e19f643 --- /dev/null +++ b/docs/registry.md @@ -0,0 +1,71 @@ +--- +title: Get Listed on the Registry +--- + +The [Agent Skills Registry](/intent/registry) automatically discovers and indexes npm packages that ship Agent Skills. There's no manual submission process — publish skills in your package and the registry picks them up. + +## How discovery works + +The registry periodically searches npm for packages with the `tanstack-intent` keyword. When it finds one, it downloads the tarball, extracts every `skills/**/SKILL.md` file, and indexes the contents. Each new version you publish gets indexed automatically. + +## Ship skills in 4 steps + +### 1. Generate skills + +Tell your AI coding agent to run: + +```bash +npx @tanstack/intent@latest scaffold +``` + +This walks the agent through domain discovery, skill tree generation, and skill creation. You review at each stage. Skills land in a `skills/` directory at your package root — each as a `SKILL.md` file in its own subdirectory. + +### 2. Validate + +```bash +npx @tanstack/intent@latest validate +``` + +Catches structural issues, missing frontmatter, and broken source references before you publish. + +### 3. Add the keyword + +Add `"tanstack-intent"` to the `keywords` array in your `package.json`: + +```json +{ + "keywords": ["tanstack-intent"] +} +``` + +This is how the registry finds your package on npm. + +### 4. Publish + +```bash +npm publish +``` + +The registry discovers your package on its next sync cycle. Your skills, version history, and download stats appear on the registry automatically. + +## Keeping skills current + +Skills derived from docs drift when docs change. Two commands keep them honest: + +```bash +npx @tanstack/intent@latest stale +``` + +Flags skills whose source docs have changed since the skill was last updated. + +```bash +npx @tanstack/intent@latest setup-github-actions +``` + +Copies CI workflow templates into your repo so validation and staleness checks run on every push. Catch drift before it ships. + +## Requesting a library + +If you use a library that doesn't ship skills yet, the best path is to open an issue on that library's repo pointing them here. The maintainer is the right person to author and own skills for their tool — they know the intent behind the API better than anyone. + +You can also point them to the [Agent Skills spec](https://agentskills.io) and the [TanStack Intent overview](/intent/latest/docs/overview) for context.