agentleFS
anam-organam-org/metaxy/.claude/skills/docs-page-frontmatter/SKILL.md

docs-page-frontmatter

Skill126 starsChanged 9 months agoApache-2.0View on GitHub

Write YAML front matter for documentation pages with appropriate titles and descriptions for social cards.

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use descriptive titles that provide context

    line 21
  2. Distinctive:

    Keep titles concise but informative

    line 23
  3. Distinctive:

    Keep descriptions general and conceptual

    line 33
  4. Distinctive:

    Use simple, direct language

    line 34
  5. Distinctive:

    Before finalizing front matter, verify:

    line 98

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation Page Front Matter

This skill guides writing YAML front matter for mkdocs-material documentation pages. Front matter controls social card generation and page metadata.

Front Matter Format

---
title: "Page Title"
description: "Brief description of the page."
---

Title Guidelines

  • Use descriptive titles that provide context
  • Include the subject matter (e.g., "LanceDB Configuration" not just "Configuration")
  • Keep titles concise but informative
  • For API reference pages: "[Subject] API" or "API reference for [Subject]"
  • For configuration pages: "[Subject] Configuration"
  • For index pages: Use the section name (e.g., "Integrations", "User Guide")

Description Guidelines

DO:

  • Briefly summarize what the page covers
  • Keep descriptions general and conceptual
  • Use simple, direct language
  • Focus on the page content, not the subject itself

DON'T:

  • Enumerate specific implementation details that may become outdated
  • List specific technologies, databases, or tools unless the page is specifically about one
  • Prescribe use cases (avoid "for local development", "ideal for production", etc.)
  • Use verbose explanations
  • Describe what the subject does (describe the page instead)

Examples

Good Descriptions

# API reference page
description: "API reference for DuckDBMetadataStore."

# Configuration page
description: "Configuration options for ClickHouseMetadataStore."

# Concept page
description: "How Metaxy calculates and tracks versions."

# Index page
description: "Available metadata store backends for Metaxy."

# Integration overview
description: "Dagster integration for Metaxy."

# Guide page
description: "Defining dependencies between features."

Bad Descriptions (Avoid These)

# Too verbose, lists specific details
description: "Connect Metaxy with orchestrators like Dagster, databases like ClickHouse and BigQuery, and plugins for SQLModel and SQLAlchemy."

# Prescribes use case
description: "Use DuckDB as a fast embedded analytical database for local development and testing with Metaxy."

# Enumerates implementation details
description: "Configuration options for DuckDBMetadataStore including database path, extensions, and DuckLake settings."

# Describes the subject, not the page
description: "A pluggable metadata layer for ML pipelines that tracks feature versions, dependencies, and data lineage."

Patterns by Page Type

Page TypeTitle PatternDescription Pattern
Overview/IndexSection nameBrief summary of section contents
API Reference"[Subject] API""API reference for [Subject]."
Configuration"[Subject] Configuration""Configuration options for [Subject]."
Concept/GuideConcept nameBrief statement of what the page explains
Example"[Name] Example"Brief statement of what the example demonstrates
Integration"[Tool] Integration""[Tool] integration for Metaxy."

Checklist

Before finalizing front matter, verify:

  • Title provides enough context to be meaningful in isolation
  • Description is one sentence or less
  • Description describes the page, not the subject
  • No specific implementation details that could become outdated
  • No prescriptive language about use cases
  • Consistent with patterns used across the documentation

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.