docs-frontmatter-audit

Name: docs-frontmatter-audit
Availability: InStock
Author: elastic

Audit Elastic documentation markdown frontmatter for required fields and formatting.

71|10|Updated Aug 20, 2025

Search Tags:#quality assurance #documentation #publishing #audit #metadata #frontmatter

Ready to run

npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-frontmatter-audit

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-frontmatter-audit
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/review/frontmatter-audit
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-frontmatter-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the tedious and error-prone process of manually checking Elastic documentation files for correct and complete frontmatter, ensuring metadata quality and consistency before publishing.

Core Features & Use Cases

Comprehensive Frontmatter Validation: Audits applies_to, products, description, and navigation_title fields against defined rules.
Metadata Quality Assurance: Catches missing required fields, incorrect values, and formatting issues.
Use Case: Before publishing a batch of documentation updates, run this skill to automatically identify any files with incomplete or incorrect frontmatter, allowing for quick fixes and preventing publishing errors.

Quick Start

Use the docs-frontmatter-audit skill to audit the frontmatter of all markdown files in the '/docs/reference' directory.

Frequently Asked Questions about docs-frontmatter-audit

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

FAQPage Schema

How do I audit markdown frontmatter for Elastic documentation before publishing?▼

You can audit markdown frontmatter by scanning files with Glob, Read, and Grep tools to validate `applies_to` keys, `products` IDs, and `description` formats. This ensures metadata completeness and correctness to prevent publishing errors.

What documentation metadata fields does a frontmatter audit check for completeness?▼

A frontmatter audit checks Elastic documentation metadata fields including `applies_to` keys, `products` IDs, `description` length and format, and recommends `navigation_title` for long H1s. This ensures all required metadata is complete and correct before publishing.

Can I use a frontmatter audit skill to validate metadata across a batch of markdown files?▼

Yes, you can validate metadata across a batch of markdown files by running the audit in directories like '/docs/reference'. It scans and parses file content to identify missing required fields, incorrect values, and formatting issues across the entire batch.

Why does my Elastic documentation fail the frontmatter check during publishing?▼

Elastic documentation fails frontmatter checks during publishing due to missing `applies_to` keys, invalid `products` IDs, incorrect `description` length or format, or missing `navigation_title` for long H1s. Running an audit identifies these specific metadata issues.

What is the best way to ensure frontmatter quality assurance for technical documentation?▼

The best way to ensure frontmatter quality assurance for technical documentation is to automate validation of required metadata fields like `applies_to` and `products` before publishing. This catches incomplete or incorrect frontmatter consistently across all markdown files.

Do I need specific tools to scan and parse markdown files for metadata validation?▼

Yes, scanning and parsing markdown files for metadata validation requires Glob, Read, and Grep tools to access file content and extract frontmatter. These tools enable the audit to check required fields for completeness and correctness.