contributing

Synchronize Keystone UI component changes with Storybook, Fumadocs, MDX, and registry files.

3|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/keystone-ui/react --skill contributing-keystone-ui
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contributing
Source: https://github.com/keystone-ui/react/tree/main/.claude/skills/contributing
Command: npx skills add https://github.com/keystone-ui/react --skill contributing-keystone-ui

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents drift between Keystone UI components and the docs, demos, registries, and AI-facing files that describe them. It helps contributors add or change UI surface areas without missing the required updates that keep the repository consistent.

Core Features & Use Cases

  • Scaffold and update components using the repository's component workflow.
  • Keep Storybook stories, Fumadocs demos, MDX docs, and registry entries aligned.
  • Maintain agent-facing assets such as skills, AGENTS.md, llms.txt, and MCP references when conventions or public APIs change.
  • Use case: when adding a new component or adjusting a shared pattern, the Skill guides the full sync process so implementation and documentation stay aligned.

Quick Start

Use the contributing skill to add or modify a component and update every related story, demo, doc, and agent surface.

Frequently Asked Questions about contributing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep Storybook stories and Fumadocs demos aligned when adding a new UI component?

To keep Storybook stories and Fumadocs demos aligned, the Skill synchronizes the Keystone UI contribution workflow by requiring scaffold-first implementation and guiding post-change updates across all related repository artifacts.

What do I need to update in the keystoneui monorepo when modifying a shared component pattern?

When modifying a shared component pattern in the keystoneui monorepo, you need to update Storybook stories, Fumadocs demos, MDX docs, registry entries, blocks, and AI-agent surfaces to prevent documentation drift.

How does the registry sync process work for Keystone UI components?

The registry sync process works by enforcing component selection alignment and composition guidance after a scaffold-first implementation, ensuring registry entries accurately reflect the updated component APIs.

When do I need to update AGENTS.md and llms.txt files during component changes?

You need to update AGENTS.md and llms.txt files whenever conventions or public APIs change, ensuring AI-agent surfaces and MCP references stay synchronized with the modified component implementations.

Does the Keystone UI workflow require a specific approach before updating documentation?

Yes, the Keystone UI workflow requires a scaffold-first implementation approach before updating documentation, ensuring the component structure is established before syncing stories, demos, and MDX docs.

What is the best way to prevent drift between UI components and their documentation?

The best way to prevent drift between UI components and their documentation is applying a comprehensive sync workflow that updates Storybook stories, Fumadocs demos, registry entries, and agent-facing assets simultaneously.