frontmatter-description
Frontmatter Description
Check and optimize MetaDescription frontmatter fields in markdown documentation files. Produces actionable fixes for descriptions that violate the rules below.
When to Use
- Adding or editing a documentation page and need to write a
MetaDescription. - Auditing existing pages for SEO or discoverability improvements.
- Asked to check, review, or optimize frontmatter descriptions.
- Editing content articles and want to ensure the
MetaDescriptionreflects the updated content.
Rules
Every MetaDescription value must satisfy all of the following:
| Rule | Detail |
|---|---|
| Length | Maximum 160 characters. |
| Tone | Action-oriented, value-focused, factual, and impersonal. |
More from microsoft/vscode-docs
content-redirect
Create and manage redirects in VS Code documentation when pages are moved, renamed, or deleted. Use when moving docs pages, renaming files, restructuring content, or when the user asks about redirects.
4release-note-reviewer
Review VS Code release notes for style, structure, and completeness. Use for reviewing Insiders or Stable release notes against writing guidelines. Produces an actionable list of recommendations.
4release-note-writer
Guidelines for writing and reviewing Insiders and Stable release notes for Visual Studio Code.
4docs-product-alignment
Audit and update docs/copilot/ documentation to accurately reflect current VS Code AI capabilities. Use when: competitive analysis reveals gaps, product launches new features, docs use outdated framing, or keyword coverage needs strengthening for discoverability by users and AI agents. Produces a gap analysis plus targeted edits across affected files.
4