Create Documentation Skill
Arguments
- file-path: Path to new
.mdx file (required, must end in .mdx)
- --type / -t:
concept (default), howto, reference, overview
- --title: Document title
- --description: Meta description (150-160 chars)
- --interactive / -i: Prompt for all fields
- --with-example: Include code block template
Process
- Validate file doesn't exist, path is valid,
.mdx extension, parent directory exists
- Apply template from
../../../templates/doc-templates/DOCUMENT_TEMPLATE.md
- Generate frontmatter (
page_title, description)
- Create content structure with Why section, implementation sections, HashiCorp Resources
- Validate: kebab-case filename, meta description 150-160 chars
Document template structure
---
page_title: <Title>
description: <Meta description 150-160 chars>
---
# <Title>
<Introduction paragraph>
## Why [topic]
**Bold challenge:** <Challenge statement>
**Bold challenge:** <Challenge statement>
**Bold challenge:** <Challenge statement>
<Solution paragraph>
## <Main Content Section>
<Content>
## HashiCorp resources
<Resources with verbs outside brackets>
## Next steps
<Cross-references>