block-readme

To generate a block README, apply the Skill to a new or significantly updated block. It reads the official conventions from a SKILL.md file and produces a ready-to-use README aligned with Universal Editor fields, variants, and lifecycle hooks.

A block README for Universal Editor compatibility should document UE fields, available variants, and dispatched events. This Skill enforces a template-driven structure to ensure these implementation details and extension points are consistently captured.

Block READMEs become inconsistent when there is no single template or workflow. This Skill automates the creation and upkeep of README.md files following official conventions to ensure consistent documentation of block usage and extension points.

You should update a block README file after implementing or significantly updating a block. Running this Skill regenerates the README content to reflect the current implementation details, brand overrides, and guidelines.

Yes, generating block documentation requires a SKILL.md file to exist. This file describes the official conventions that the Skill reads to produce a README aligned with the Universal Editor fields and variants.

Yes, you can document brand overrides in a block README. This Skill provides brand override guidance within its template, explaining how to adapt blocks per brand and token overrides for clear documentation.