changelog

Create and validate Cloudflare changelog MDX entries with consistent frontmatter.

5.1k|16.3k|Updated Sep 3, 2020
One-click install
npx skills add https://github.com/cloudflare/cloudflare-docs --skill changelog-cloudflare
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/cloudflare/cloudflare-docs/tree/main/.agents/skills/changelog
Command: npx skills add https://github.com/cloudflare/cloudflare-docs --skill changelog-cloudflare

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams create, update, and review product changelog entries for the Cloudflare documentation site. It loads when generating changelog MDX files, editing existing entries, reviewing changelog style, or validating frontmatter.

Core Features & Use Cases

  • Create new changelog entries under src/content/changelog/{product}/
  • Edit existing entries and validate frontmatter
  • Review changelog style and ensure consistency across products

Quick Start

Provide the product name, change description, and date to generate a new changelog entry.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I automate changelog entry creation for product documentation?

Automate changelog entry creation by providing a product name, change description, and date to generate a new MDX file under the correct product folder. This ensures consistent frontmatter fields like title, description, products, and date are automatically populated.

What frontmatter fields are required for a valid MDX changelog entry?

Valid MDX changelog entries require consistent frontmatter fields including title, description, products, and date. Validating frontmatter ensures entries adhere to documented writing style guidelines and maintain consistency across products in the src/content/changelog/ directory.

How do I organize changelog entries by product in MDX format?

Organize changelog entries by placing new MDX files into the correct product folder under src/content/changelog/{product}/. This structure ensures product changes are properly categorized and easily accessible for documentation review.

Can I edit existing changelog entries and validate their formatting?

Edit existing changelog entries and validate their frontmatter to ensure adherence to documented writing style guidelines. This maintains consistency across products and prevents formatting errors within the src/content/changelog/ directory.

What is the best way to maintain consistency across multiple product changelogs?

Maintain changelog consistency by validating frontmatter fields and adhering to documented writing style guidelines during entry creation and review. This ensures all product updates under src/content/changelog/ follow the same structural format.

Why do my changelog MDX files fail style validation?

Changelog MDX files fail style validation when frontmatter fields like title, description, products, or date are missing or inconsistent. Reviewing changelog style and validating frontmatter ensures entries meet the documented writing guidelines.