Skip to main content

​
Overview

Content and documentation automations help maintain high-quality content with less manual effort. These automations can generate metadata, check for consistency, and enhance SEO.

​
Example: Blog Post Frontmatter Generator

Use Case: Automatically generate SEO-friendly metadata for blog posts. How it works:
  • Triggered when a PR adds or modifies markdown files in the blog directory
  • Reads the blog post content
  • Generates title suggestions, descriptions, and tags
  • Updates the frontmatter in the file
  • Comments on the PR with the suggestions
Trigger: PR opened with changes to blog/**/*.md Prompt Template: 
A blog post has been added or modified in {file_path}.

1. Read the blog post content
2. Generate SEO-optimized metadata:
   - Title suggestions (3 options, max 60 characters)
   - Meta description (max 160 characters)
   - 5-7 relevant tags/keywords
   - Suggested social media preview text

3. Check if frontmatter exists:
   - If missing: Add complete frontmatter with generated content
   - If exists: Suggest improvements in a PR comment

4. Create a commit with the frontmatter changes
5. Comment on the PR with:
   - The generated metadata
   - SEO score and suggestions
   - Alternative title options for the author to consider
MCP Servers Needed: GitHub Content Guidelines:
  • Keep titles under 60 characters for SEO
  • Descriptions should be compelling and include keywords
  • Use markdown formatting in descriptions sparingly
  • Include publication date and author metadata

​
Tips for Content & Documentation Automations

​
Respect Author Intent

Always provide suggestions rather than forcing changes. Authors should have final say on titles and descriptions.

​
Maintain Brand Voice

When generating content, ensure it matches your company’s brand voice and tone. Include brand guidelines in your automation prompts.

​
Check for Consistency

Automate checks for consistent terminology, formatting, and style across documentation.

​
Generate, Don’t Replace

Use AI to generate first drafts or suggestions, but human review should always be part of the workflow for published content.

​
SEO Best Practices

Include SEO best practices in your automation prompts:
  • Target keyword placement
  • Character limits for titles and descriptions
  • Meta tag optimization
  • Social media preview optimization