Skip to content

feat(skills): ship a consumer skill with the package - #20

Merged
Upd4ting merged 4 commits into
mainfrom
feat/package-shipped-skill
Jul 20, 2026
Merged

feat(skills): ship a consumer skill with the package#20
Upd4ting merged 4 commits into
mainfrom
feat/package-shipped-skill

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Jul 19, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds skills/<name>-interface/SKILL.md: a lean, source-grounded consumer guide (imports per subpath, minimal example, gotchas, pointer to the shipped .d.ts)
  • Wires it for distribution: antelopeJs.skills: ["./skills"] + skills in the files array
  • Consumers get it automatically: the antelopejs Claude Code plugin syncs package-shipped skills into .claude/skills/; the cms-ai chatbox loads them at runtime
  • Content fact-checked against src//docs/ by an adversarial review pass (imports validated against the exports map, examples verified against real signatures)

Test plan

N/A (documentation artifact; frontmatter and import paths validated mechanically)

Greptile Summary

This PR ships a consumer-facing skill document (skills/data-api-interface/SKILL.md) alongside updates to package.json that publish the docs/ and skills/ directories with the npm package and register the skills path in the AntelopeJS config.

  • SKILL.md provides a lean consumer guide covering imports per subpath, a minimal working example, and key gotchas (decorator requirements, list response shape, filter syntax, @Joined/@Computed sort/filter behavior). All import paths, exported symbols, and behavioral claims were cross-validated against src/index.ts, src/metadata.ts, and src/components.ts.
  • package.json adds "docs" and "skills" to the files array so both are published to npm, and adds "skills": ["./skills"] to the antelopeJs config block for plugin-driven skill syncing.

Confidence Score: 5/5

This PR is safe to merge — it adds a documentation artifact and updates packaging metadata with no changes to runtime code.

All exported symbols listed in the skill's import block were confirmed present in the respective source files. Behavioral descriptions — default/max list limit (10/100), 400 on unsortable sortKey, filter format, @Joined/@computed read-only enforcement — were traced to their implementations. The docs and skills directories existed in the repo prior to this PR; their addition to the npm files array simply makes them accessible to consumers of the published package.

No files require special attention.

Important Files Changed

Filename Overview
skills/data-api-interface/SKILL.md New consumer skill guide; all exports, signatures, and behavioral descriptions validated against source — no inaccuracies found.
package.json Adds docs and skills to npm files array and registers the skills directory in the AntelopeJS config; straightforward packaging change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["npm publish\n(package.json files array)"] --> B["dist/"]
    A --> C["docs/\n(now included)"]
    A --> D["skills/\n(now included)"]
    D --> E["data-api-interface/SKILL.md"]
    F["antelopeJs.skills\n./skills"] --> G["AntelopeJS Claude Code plugin\nsyncs to .claude/skills/"]
    F --> H["cms-ai chatbox\nloads at runtime"]
    E --> G
    E --> H
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["npm publish\n(package.json files array)"] --> B["dist/"]
    A --> C["docs/\n(now included)"]
    A --> D["skills/\n(now included)"]
    D --> E["data-api-interface/SKILL.md"]
    F["antelopeJs.skills\n./skills"] --> G["AntelopeJS Claude Code plugin\nsyncs to .claude/skills/"]
    F --> H["cms-ai chatbox\nloads at runtime"]
    E --> G
    E --> H
Loading

Reviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile

Add skills/<name>-interface/SKILL.md — a lean, source-grounded guide for
agents consuming this interface (imports, minimal example, gotchas) —
declared via antelopeJs.skills and published through the files array.
Consumers receive it automatically: the antelopejs Claude Code plugin
syncs package-shipped skills into a project's .claude/skills/, and the
cms-ai chatbox loads them at runtime.

Content was fact-checked against src/ and docs/ by an adversarial
review pass (imports validated against the exports map, examples
verified against real signatures).
Comment thread skills/data-api-interface/SKILL.md
Comment thread skills/data-api-interface/SKILL.md Outdated
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit fcbde72 into main Jul 20, 2026
3 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant