diff --git a/content/skills-sh.mdx b/content/skills-sh.mdx new file mode 100644 index 0000000..49baa27 --- /dev/null +++ b/content/skills-sh.mdx @@ -0,0 +1,53 @@ +# Agent Skills + +Agent skills for building TypeComposer apps directly from your AI coding assistant. + +## What are agent skills? + +Agent Skills are an open format for extending AI coding assistants with specialised knowledge +and capabilities. They follow the [Agent Skills](https://agentskills.io) specification. + +Skills are markdown files (`SKILL.md`) that contain step-by-step instructions for an AI +agent. When you ask your assistant something like "scaffold a TypeComposer component" or +"open a PR to add a reactivity test," the agent selects the matching skill and follows its +instructions automatically. + +### Supported tools + +The TypeComposer skill works with any Agent Skills-compatible AI coding assistant, including +Claude Code, OpenAI Codex, Cursor, and other tools that support the specification. + +## Installation + +Install the TypeComposer skill with a single command: + +```bash +npx skills add TypeComposer/skill +``` + +This registers the skill with your AI assistant and makes the TypeComposer knowledge base +available in your current workspace. + +## The TypeComposer skill + +The repository ships one skill: **TypeComposer Framework Contributor**. It follows a +route-first design — your intent is matched to the correct repo and workflow, then +execution details are resolved from structured reference files. + +### Workflow coverage + +| Task | Coverage | +|---|---| +| Scaffold a new project or library | ✓ | +| Create or update components using the zero-HTML TypeScript model | ✓ | +| Review and open pull requests (framework, docs, plugin, SSR, create) | ✓ | +| Update documentation pages and MDX content | ✓ | +| Add or fix Vitest tests against the component testing baseline | ✓ | +| Investigate issues in `plugin`, `create`, `ssr`, or `language-service` | ✓ | +| Respond to maintainer feedback on open PRs | ✓ | +| Align changes with the TypeComposer roadmap | ✓ | + +## Source + +The TypeComposer agent skill is open-source and available on +[GitHub](https://github.com/TypeComposer/skill). \ No newline at end of file diff --git a/src/assets/data.json b/src/assets/data.json index fba258a..152986d 100644 --- a/src/assets/data.json +++ b/src/assets/data.json @@ -10,6 +10,10 @@ { "title": "Getting Started", "link": "docs/getting-started" + }, + { + "title": "Skills.sh AI Skill", + "link": "docs/skills-sh" } ] }, @@ -137,4 +141,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/src/router/router.ts b/src/router/router.ts index b56e205..dae0852 100644 --- a/src/router/router.ts +++ b/src/router/router.ts @@ -15,6 +15,7 @@ loadDocs().finally(() => { component: AppPage, children: [ { path: "getting-started", component: BaseView }, + { path: "skills-sh", component: BaseView }, { path: "components/component", component: BaseView }, { path: "components/template", component: BaseView }, { path: "components/lifecycle-docs", component: BaseView },