From 46c429ec7d7722d2d3ccc4f40c177308a444082c Mon Sep 17 00:00:00 2001 From: studiolxd Date: Mon, 15 Jun 2026 22:15:06 +0200 Subject: [PATCH] chore: extract skills to studiolxd/scorm-skills; link from README + llms.txt The agent skills now live in their own repo (single source of truth). Remove the duplicated skills/ folder from the monorepo and point to it from the library README and llms.txt. Co-Authored-By: Claude Opus 4.8 (1M context) --- packages/scorm/README.md | 12 +++ packages/scorm/llms.txt | 1 + skills/README.md | 43 ----------- skills/build/agents/scorm-integration.md | 72 ------------------ .../.claude-plugin/marketplace.json | 15 ---- .../.claude-plugin/plugin.json | 5 -- .../skills/scorm-integration/SKILL.md | 75 ------------------ skills/build/cursor/scorm-integration.mdc | 76 ------------------- skills/scripts/build.mjs | 69 ----------------- skills/source/skill.md | 76 ------------------- 10 files changed, 13 insertions(+), 431 deletions(-) delete mode 100644 skills/README.md delete mode 100644 skills/build/agents/scorm-integration.md delete mode 100644 skills/build/claude-plugin/.claude-plugin/marketplace.json delete mode 100644 skills/build/claude-plugin/plugins/scorm-integration/.claude-plugin/plugin.json delete mode 100644 skills/build/claude-plugin/plugins/scorm-integration/skills/scorm-integration/SKILL.md delete mode 100644 skills/build/cursor/scorm-integration.mdc delete mode 100644 skills/scripts/build.mjs delete mode 100644 skills/source/skill.md diff --git a/packages/scorm/README.md b/packages/scorm/README.md index 867e76a..1849719 100644 --- a/packages/scorm/README.md +++ b/packages/scorm/README.md @@ -449,6 +449,18 @@ const path: Scorm12CmiPath = 'cmi.core.lesson_status'; // OK // const bad: Scorm12CmiPath = 'cmi.core.typo'; // ERROR ``` +## AI coding agents + +Using Claude Code, Cursor, or another AI coding assistant? Add the **[scorm-skills](https://github.com/studiolxd/scorm-skills)** so the agent knows how to use this library: + +``` +# Claude Code +/plugin marketplace add studiolxd/scorm-skills +/plugin install scorm-integration@studiolxd-scorm + +# Cursor: copy cursor/scorm-integration.mdc into your project's .cursor/rules/ +``` + ## Additional Documentation - [SCORM 1.2 vs 2004 Mapping Table](./docs/scorm-mapping-table.md) diff --git a/packages/scorm/llms.txt b/packages/scorm/llms.txt index 71a7d57..b49cf22 100644 --- a/packages/scorm/llms.txt +++ b/packages/scorm/llms.txt @@ -5,6 +5,7 @@ > Angular, Svelte, and Web Components. Every API call returns a typed Result. Install: `npm i @studiolxd/scorm` +Agent skill (Claude Code / Cursor): https://github.com/studiolxd/scorm-skills ## Entry points (subpath imports) diff --git a/skills/README.md b/skills/README.md deleted file mode 100644 index b347596..0000000 --- a/skills/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# scorm-skills - -Agent instructions that teach AI coding tools how to use `@studiolxd/scorm`. - -**One canonical source → many tool formats.** Everything in `build/` is generated; -edit only `source/skill.md`. - -``` -source/skill.md # the single source of truth (edit this) -scripts/build.mjs # generator: source → build/* -build/ # generated (do not edit by hand) - claude-plugin/ # Claude Code plugin + marketplace - .claude-plugin/marketplace.json - plugins/scorm-integration/... - cursor/scorm-integration.mdc # Cursor rule - agents/scorm-integration.md # portable baseline (Antigravity, Copilot, generic) -``` - -Regenerate after editing the source: - -```bash -node skills/scripts/build.mjs -``` - -## Using it per tool - -- **Claude Code** — add `skills/build/claude-plugin` as a plugin marketplace (its - `.claude-plugin/marketplace.json`), then install the `scorm-integration` plugin. - For distribution, publish `build/claude-plugin` as its own public repo. -- **Cursor** — copy `build/cursor/scorm-integration.mdc` into your project's - `.cursor/rules/`. -- **Other agents (Antigravity, Copilot, …)** — drop `build/agents/scorm-integration.md` - into the project (e.g. append to `AGENTS.md`), or point the tool's rules at it. - -## Why this is separate from the npm package - -The runtime package `@studiolxd/scorm` ships only `dist/` + `llms.txt` — it stays lean. -Agent skills target a different audience (coding-assistant toolchains) and are -distributed via marketplaces/rules, not `npm install`. Per the plan they live in a -dedicated location (here, intended to be published as `studiolxd/scorm-skills`). - -> Note: marketplace/plugin manifest schemas evolve — verify `marketplace.json` and -> `plugin.json` against the current Claude Code plugin docs before publishing. diff --git a/skills/build/agents/scorm-integration.md b/skills/build/agents/scorm-integration.md deleted file mode 100644 index 33e1154..0000000 --- a/skills/build/agents/scorm-integration.md +++ /dev/null @@ -1,72 +0,0 @@ -# scorm-integration - -# Using @studiolxd/scorm - -`@studiolxd/scorm` is a headless SCORM 1.2/2004 runtime. A framework-agnostic core -(`createScormSession`) plus thin adapters. Built-in **mock mode** runs without an LMS. - -## Pick the entry point - -- Vanilla / any framework: `import { createScormSession } from '@studiolxd/scorm'` -- React: `import { ScormProvider, useScorm, useScormSession } from '@studiolxd/scorm/react'` -- Vue: `import { useScorm } from '@studiolxd/scorm/vue'` -- Angular (>=17): `import { provideScorm, SCORM } from '@studiolxd/scorm/angular'` -- Svelte: `import { createScormStore } from '@studiolxd/scorm/svelte'` -- Web Component: `import '@studiolxd/scorm/wc'` then `` -- CDN `