skills.rest
udecode
udecodeOFFICIAL
Explore all skills by this author →
WebsiteGitHub

registry-changelog

Author and verify Plate registry changelog entries for user-visible registry changes.

16.5k|997|Updated Dec 2, 2019
Search Tags:#release notes#codegen#mdx#Documentation#plate#REGISTRY#ChangeLog
One-click install
npx skills add https://github.com/udecode/plate --skill registry-changelog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: registry-changelog
Source: https://github.com/udecode/plate/tree/main/.agents/skills/registry-changelog
Command: npx skills add https://github.com/udecode/plate --skill registry-changelog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It ensures every user-visible change to Plate registry UI components, kits, examples, and registry metadata is documented with a consistent, machine-generated changelog entry instead of ad-hoc or missing release notes.

Core Features & Use Cases

  • MDX Entry Authoring: Defines a strict frontmatter contract (id, date, status, kind, summary, change, release, diagnostics) for changelog source files under apps/www/src/registry/changelog/entries.
  • Generator Workflow: Provides commands to create new entries, regenerate public JSON artifacts, and verify source and generated output agree.
  • Scope Classification: Distinguishes registry changelog entries from package changesets and defines when an entry is required versus N/A.
  • Use Case: After modifying a registry UI component like the editor renderer, create a dated MDX entry, run the generator with --write, and confirm --check passes before handoff.

Quick Start

Create a registry changelog entry for my changes to the editor component, regenerate the public JSON, and verify the output passes the check.

Frequently Asked Questions about registry-changelog

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

FAQPage Schema
How do I add a changelog entry for Plate registry changes?▼

Create an MDX file under apps/www/src/registry/changelog/entries with the required frontmatter fields, or run the generator script with --new, --summary, --items, and --kind flags. Then regenerate the public JSON with --write and verify with --check.

When is a registry changelog entry required in Plate?▼

An entry is required when a task changes user-visible registry behavior, copied-code install shape, kit composition, examples, style dependencies, or component rendering. Mark it N/A only for non-user-visible diffs like tests or internal plans.

Should I edit the generated changelog JSON files directly?▼

No, never hand-edit generated changelog JSON under apps/www/src/registry/changelog. Edit the MDX source entry instead, then run the generator script with --write to regenerate the public artifacts.

What is the difference between a registry changelog entry and a package changeset?▼

A package changeset covers published package user-visible deltas, while a registry changelog entry covers user-visible registry deltas. Registry-only work under apps/www/src/registry uses the registry changelog instead of a package changeset; mixed work may need both.

What fields are required in a registry changelog MDX entry?▼

Required frontmatter fields are id, date, status, kind, summary, change, release, and diagnostics. Kind must be one of new, fix, behavior, wiring, rename, or remove, and bullet rows must name real registry item ids in backticks.

Related Skills

Explore More Software Engineering Skills→
medusajsmedusajs
36.1k

writing-docs

Writes and updates Medusa MDX documentation across book, resources, ui, user-guide, and cloud projects.

Official
Advanced
berkayoztuncberkayoztunc
21

Sitemap Support

Generate a dynamic /sitemap.xml endpoint with lastmod values for Orquestra pages.

Community
Basic
JacobLeyJacobLey
9

versioning

Generate per-PR changesets and changelogs for multi-package repositories.

Community
Intermediate
pwarnockpwarnock
2

release-publishing

Automate release planning and publishing workflows with Changesets and semantic versioning.

Community
Intermediate