docs-changelog

Create EN/ZH paired changelog posts with consistent frontmatter for docs/changelog/*.mdx.

Updated May 11, 2026
One-click install
npx skills add https://github.com/zmh13928433602-sys/lobe-chat --skill docs-changelog-zmh13928433602-sys
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-changelog
Source: https://github.com/zmh13928433602-sys/lobe-chat/tree/main/.agents/skills/docs-changelog
Command: npx skills add https://github.com/zmh13928433602-sys/lobe-chat --skill docs-changelog-zmh13928433602-sys

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps teams produce consistent, user-facing changelog posts for docs/changelog/*.mdx, ensuring clarity and proper localization and avoiding release-note confusion.

Core Features & Use Cases

  • Naming conventions: Enforces date-based filenames for EN and zh-CN equivalents.
  • Frontmatter discipline: Requires title, description, and tags in frontmatter, with aligned EN/ZH versions.
  • Content structure: Outlines the recommended document structure and writing rules for changelog entries.

Quick Start

Create a new EN changelog file named docs/changelog/YYYY-MM-DD-topic.mdx (and a matching zh-CN version) following this guide.

Frequently Asked Questions about docs-changelog

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

FAQPage Schema
How do I write bilingual changelog entries for MDX documentation?▼

To write bilingual changelog entries, create paired EN and zh-CN MDX files in the docs/changelog directory with consistent frontmatter, including matching titles, descriptions, and tags across both language versions for ready-to-publish release notes.

What frontmatter is required for docs changelog MDX files?▼

Required frontmatter for changelog MDX files includes title, description, and tags. You must align these fields across paired EN and zh-CN versions to enforce frontmatter discipline and ensure proper localization of release notes.

What is the correct file naming convention for documentation changelogs?▼

The correct file naming convention for documentation changelogs uses date-based filenames formatted as YYYY-MM-DD-topic.mdx, requiring matching zh-CN equivalents to maintain organized and chronologically sorted EN/ZH paired release notes.

How should I structure content and tone for user-facing release notes?▼

Structure release notes by following recommended document outlines and writing guidelines that ensure clarity and a consistent tone. Include a Quick Start section to produce user-friendly changelog entries that prevent release-note confusion.