---
title: "documentation description rule"
description: "Every file in the docs folder must include a 'description' field in its frontmatter that accurately summarizes the content of the page in 100-160 characters. The description should be concise, keyword-rich, and explain what users will learn or accomplish from the page."
type: skill
canonical_url: https://claudary.paisolsolutions.com/skills/documentation-description-rule
source: "Claudary"
difficulty: intermediate
author: "Claude Code Knowledge Pack"
date: 2026-07-10T11:19:59.818Z
license: CC-BY-4.0
attribution: "documentation description rule — Claudary (https://claudary.paisolsolutions.com/skills/documentation-description-rule)"
---

# documentation description rule
Every file in the docs folder must include a 'description' field in its frontmatter that accurately summarizes the content of the page in 100-160 characters. The description should be concise, keyword-rich, and explain what users will learn or accomplish from the page.

## Overview

---
globs: docs/**/*.{md,mdx}
description: This rule applies to all documentation files to ensure consistent
  SEO optimization and improve discoverability. It helps users and search
  engines understand the content of each page before reading it.
---

Every file in the docs folder must include a 'description' field in its frontmatter that accurately summarizes the content of the page in 100-160 characters. The description should be concise, keyword-rich, and explain what users will learn or accomplish from the page.

---

Source: [Claudary](https://claudary.paisolsolutions.com/skills/documentation-description-rule) · https://claudary.paisolsolutions.com