docs-conventions

What problem does it solve?

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.

Core Features & Use Cases

• MDX Frontmatter Standards: Enforces required frontmatter fields (name, description, title, etc.) and consistent metadata for SEO and navigation.
• Reusable React Components & Patterns: Provides guidelines for using Steps, ActionCard, Next Steps, and other components to create uniform layouts across tutorials, references, and guides.
• Guided Authoring for Tutorials & References: Applies to new pages and edits to maintain consistent navigation, inline notes, collapsible sections, and hyperlinks.
• Use Case: A content author updates a docs page and automatically adheres to the established frontmatter and component usage patterns.

Quick Start

Create or edit a docs page using the MDX frontmatter and component patterns described here.