Enforce MDX frontmatter and component patterns for docs.cloudposse.com documentation.
npx skills add https://github.com/cloudposse/docs --skill docs-conventions
Please help me install this Agent Skill. Skill: docs-conventions Source: https://github.com/cloudposse/docs/tree/main/.claude/skills/docs-conventions Command: npx skills add https://github.com/cloudposse/docs --skill docs-conventions
Documentation on docs.cloudposse.com suffers from inconsistent structure, frontmatter, and component usage. This Skill defines and enforces a standardized approach to MDX frontmatter, reusable components, and content patterns to ensure cohesive, maintainable documentation.
Create or edit a docs page using the MDX frontmatter and component patterns described here.
High-intent search queries and answers about installing and using this skill.
To enforce consistent MDX frontmatter, define required fields such as name, description, and title. This ensures standardized metadata for SEO and uniform navigation across all documentation pages.
Use reusable React components such as Steps, ActionCard, and Next Steps to create uniform layouts. These components ensure consistent navigation and structured content across tutorials, references, and guides.
Structure tutorials and reference guides by applying standardized MDX frontmatter, reusable React components, and consistent patterns for code blocks, inline notes, and collapsible sections to maintain cohesive content.
Yes, these documentation conventions apply to both creating new pages and editing existing ones. They automatically enforce established frontmatter and component usage patterns to maintain structural consistency.
The limitations of these MDX documentation patterns involve strict adherence to predefined frontmatter naming and specific React component structures, which may restrict custom layout implementations and freeform content.
wlfmnstrDesign Zod frontmatter schemas and MDX processing pipelines for documentation sites.
mpsuesserConvert MDX content into structured documentation sites with docs.json navigation.
gil00pitaCombine Markdown with React components to build interactive content.
dt418Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.
