Moai Docs Linting

What it does

The moai-docs-linting skill analyzes documentation text for common errors and inconsistencies, ensuring higher quality and readability. It checks for things like incorrect Markdown syntax, missing links, and adherence to specific style guidelines. The tool helps maintain a consistent voice and improves the overall user experience of technical documentation.

When to use it

• Reviewing newly written documentation: Before publishing new content, run this skill to catch errors early.
• Maintaining existing documentation: Regularly lint your docs to ensure they remain accurate and up-to-date.
• Enforcing style guides: Use the skill to automatically check for compliance with established documentation standards.
• Preparing documentation for release: Before a product launch or major update, use this skill as part of your final quality assurance process.

Key capabilities

• Markdown syntax checking
• Link validation (checking if links are broken)
• Style guide enforcement (specific details not provided in source)

Example prompts

• "Lint the following documentation: [paste documentation text here]"
• "Check this Markdown file for errors and suggest improvements: [file path/name]"
• "Can you review this doc for any style inconsistencies?"

Tips & gotchas

The skill's effectiveness depends on having a clearly defined style guide. Without specific rules, the linting will be less targeted and potentially generate more noise than signal.