block-readme

Name: block-readme
Availability: InStock
Author: aramark-destinations

Generate block README.md files from an official template with UE fields and lifecycle hooks.

Updated Aug 23, 2026

Search Tags:#documentation #readme #engineering #block #block-development #universal-editor

Ready to run

npx skills add https://github.com/aramark-destinations/aramark-mb --skill block-readme

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: block-readme
Source: https://github.com/aramark-destinations/aramark-mb/tree/main/.agents/skills/eds/block-readme
Command: npx skills add https://github.com/aramark-destinations/aramark-mb --skill block-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Block READMEs are often inconsistent and hard to maintain. This skill provides a single, official template and workflow to create or update a block README.md that clearly describes the block's purpose, usage, and extension points.

Core Features & Use Cases

Template-driven structure — enforces a consistent README layout for all blocks.
Brand override guidance — explains how to adapt blocks per brand and token overrides.
UE fields, variants, and events — documents the fields used by the Universal Editor, available variants, and dispatched events.
Use Case — after implementing or significantly updating a block, generate its README to reflect current implementation and guidelines.

Quick Start

Create or update the block's README.md using the official template after finishing the block.

Frequently Asked Questions about block-readme

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

FAQPage Schema

How do I generate a standardized README for an editor block?▼

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.

What should a block README include for Universal Editor compatibility?▼

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.

Why are my block README files inconsistent across the codebase?▼

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.

When should I update an existing block README file?▼

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.

Do I need a SKILL.md file before generating block documentation?▼

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.

Can I document brand overrides and token adaptations in a block README?▼

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.