name: 📝 Documentation Update
description: Suggest improvements to documentation
title: "[DOCS] "
labels: ["documentation"]
body:
  - type: markdown
    attributes:
      value: Thanks for taking the time to help us update our Documentation!
  - type: dropdown
    id: issue-type
    attributes:
      label: What type of documentation issue are you seeing?
      multiple: true
      options:
        - Outdated information
        - Missing documentation
        - Unclear/confusing content
        - Broken links or formatting
        - Example code not working
        - API reference incorrect
        - Typos or grammar issues
    validations:
      required: false
  - type: dropdown
    id: issue-location
    attributes:
      label: Where is the documentation issue located?
      multiple: true
      options:
        - README.md
        - Code examples (specify which file)
        - API docstrings (specify module/class/method)
        - Sphinx documentation (specify page)
        - CONTRIBUTING.md
        - Other (please specify) 
    validations:
      required: false
  - type: input
    id: issue-type-specifics
    attributes:
      label: Issue Type Specifics. You can insert a link to the problem area as well.
      description: Provide requested specifics.
      placeholder: ex. `CODE_OF_CONDUCT.md`
    validations:
      required: false
  - type: textarea
    id: current-problem
    attributes:
      label: What is the problem with the documentation?
      description: Also tell us, what should be changed, added, or clarified??
    validations:
      required: true
  - type: textarea
    id: anything-else
    attributes:
      label: Anything else?
      description: |
        Links? References? Anything that will give us more context about the issue you are encountering!
        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
    validations:
      required: false
  - type: checkboxes
    id: pr-willing
    attributes:
      label: Willing to Submit Pull Request
      description: Are you willing to submit a PR to fix this? 
      options:
        - label: I am willing to submit a PR to fix this.
          required: false