improve-docs

name: improve-docs description: Evaluate and improve documentation for correctness, clarity, and completeness

Documentation Improvement Guidelines

Evaluation Criteria

Review the documentation and identify:

• Missing critical information that users need
• Outdated content that doesn't match current implementations
• Unnecessary verbosity or redundant sections
• Unclear or overly complex wording
• Missing or inadequate usage examples

Improvement Process

1. Verify correctness: Ensure all technical details match the current implementation
2. Add missing information: Include important details that are absent
3. Remove cruft: Delete redundant, outdated, or unnecessary content
4. Simplify wording: Use clear, concise language (terse but not at the expense of clarity)
5. Ensure Usage section: Add a ## Usage section if the documentation would benefit from practical examples
6. Preserve autogenerated content: Do not modify sections that are clearly autogenerated (terraform-docs, API references, etc.)

Style Guidelines

• Leave a blank line after all headings
• Use emoji sparingly, generally only in headings if at all
• Avoid em dashes (—)
• Prioritize clarity over brevity, but keep content terse
• Use direct, simple language

Output

Provide the improved documentation with specific notes on:

• What information was added and why
• What content was removed and why
• Any areas that need clarification from the author