name: 📚 Documentation Issue
description: Report an issue with documentation or suggest documentation improvements
title: "[Docs]: "
labels: ["documentation", "triage"]
assignees: []

body:
  - type: markdown
    attributes:
      value: |
        Help us improve the documentation! Report issues or suggest improvements below.

  - type: dropdown
    id: issue-type
    attributes:
      label: Documentation Issue Type
      description: What type of documentation issue is this?
      options:
        - Incorrect/Outdated Information
        - Missing Documentation
        - Confusing/Unclear Explanation
        - Broken Link
        - Typo/Grammar
        - Code Example Doesn't Work
        - Missing Code Example
        - Suggestion for Improvement
        - Translation Issue
        - Other
    validations:
      required: true

  - type: textarea
    id: description
    attributes:
      label: Issue Description
      description: Describe the documentation issue
      placeholder: The documentation says X but it should say Y...
    validations:
      required: true

  - type: dropdown
    id: doc-section
    attributes:
      label: Documentation Section
      description: Which documentation is affected?
      options:
        - README.md
        - Getting Started (docs/getting-started.md)
        - Configuration Reference (docs/configuration.md)
        - Commands Reference (docs/commands-reference.md)
        - Agents Guide (docs/agents-guide.md)
        - Skills Reference (docs/skills-reference.md)
        - Best Practices (docs/best-practices.md)
        - Troubleshooting (docs/troubleshooting.md)
        - Examples (docs/examples/)
        - Command Documentation (commands/*.md)
        - Agent Documentation (agents/*.md)
        - Skill Documentation (skills/*.md)
        - Template Documentation (templates/*.md)
        - CHANGELOG.md
        - CONTRIBUTING.md
        - Other
    validations:
      required: true

  - type: input
    id: file-path
    attributes:
      label: File Path
      description: Exact file path if known
      placeholder: "docs/getting-started.md"

  - type: input
    id: line-number
    attributes:
      label: Line Number(s)
      description: Specific line number(s) if applicable
      placeholder: "Line 42"

  - type: textarea
    id: current-content
    attributes:
      label: Current Content
      description: Quote the current documentation (if reporting incorrect info)
      placeholder: |
        > Current documentation says:
        > "To do X, run Y command..."
      render: markdown

  - type: textarea
    id: suggested-content
    attributes:
      label: Suggested Content
      description: What should the documentation say instead?
      placeholder: |
        Should say:
        "To do X, run Z command with --option flag..."
      render: markdown

  - type: textarea
    id: code-example
    attributes:
      label: Code Example Issue
      description: If reporting a broken code example, paste it here
      placeholder: |
        ```bash
        # This example doesn't work:
        /command --broken-flag
        ```
      render: markdown

  - type: dropdown
    id: severity
    attributes:
      label: Impact
      description: How much does this affect users?
      options:
        - Critical (blocks users from using the plugin)
        - High (causes significant confusion)
        - Medium (minor confusion or inconvenience)
        - Low (typo or formatting issue)
    validations:
      required: true

  - type: textarea
    id: context
    attributes:
      label: Additional Context
      description: Why is this documentation problematic? How did you discover it?
      placeholder: |
        I was trying to configure X and the documentation led me to...

  - type: checkboxes
    id: contribution
    attributes:
      label: Contribution
      description: Would you like to fix this yourself?
      options:
        - label: I'd like to submit a PR to fix this documentation issue
          required: false
        - label: I can help review documentation fixes
          required: false

  - type: textarea
    id: related
    attributes:
      label: Related Issues/PRs
      description: Any related issues or pull requests?
      placeholder: |
        - Related to #123
        - Fixes #456

  - type: checkboxes
    id: checklist
    attributes:
      label: Pre-submission Checklist
      description: Please confirm
      options:
        - label: I have searched existing issues to ensure this isn't a duplicate
          required: true
        - label: I have clearly identified the documentation issue
          required: true
        - label: I have provided the specific documentation section/file
          required: true