Alpha Version: You are viewing the ALPHA documentation. This is an experimental version and may contain breaking changes.
Skip to main content

Updating Skills

Skills encode framework knowledge. When the framework changes, skills must be updated to stay accurate.

Triggers for Skill Updates

Framework ChangeSkills to Update
New component type addedreventless-app (component-catalog.md), event-sourcing-cqrs (concept-map.md)
Component spec changedreventless-app (relevant pattern file)
New compiler warning patternrescript (common-pitfalls.md)
ReScript version upgraderescript (syntax-quick-reference.md)
sury-ppx behavior changerescript (sury-ppx-patterns.md)
New AWS adapterreventless-aws (adapter-architecture.md)
New deployment strategyreventless-aws (runtime-patterns.md)
Plugin composition pattern changereventless-app (aggregate-patterns.md, dcb-patterns.md)
Testing DSL changereventless-testing (behavior-test-dsl.md)
New naming conventionreventless-context (discovery-checklist.md)

Update Process

  1. Update the reference file in .claude/skills/{skill}/references/
  2. Update the corresponding Docusaurus page if one exists
  3. Commit both in the same PR to prevent drift

Keeping Skills and Docs in Sync

Skills and Docusaurus docs serve different audiences:

ContentLocationAudience
AI instructions and code templatesSKILL.md + references/The AI assistant
Human tutorials ("how to collaborate with the AI")docs-app/ai-assisted/App developers
Skill maintenance guidesdocs-framework/ai-skills/Framework developers

Do not duplicate. Existing guides like docs/guides/aggregate-vs-dcb-decision-guide.md are shared — both AI and humans read them. Skills reference these files by path rather than copying content.

Versioning

The .claude-plugin/ directory contains Claude Code plugin distribution metadata (marketplace.json, plugin.json). These files are open source (MIT) and checked into the repo. They enable the Claude Code plugin marketplace to discover and distribute Reventless skills.

Bump the plugin version in both files when skills are updated. Follow semantic versioning:

  • Patch — typo fixes, clarifications, minor reference updates
  • Minor — new reference files, new skills, expanded coverage
  • Major — breaking changes to skill activation or command behavior
note

The plugin marketplace distribution mechanism (.claude-plugin/) is specific to Claude Code. Other AI assistants (Cursor, Copilot, Codex CLI) discover skills directly from .claude/skills/ without needing these files.