# yaml-language-server: $schema=https://www.schemastore.org/github-issue-forms.json
name: Documentation
description: Report incorrect, missing or unclear documentation.
type: Task
labels:
  - docs
body:
  - type: markdown
    attributes:
      value: |
        This form covers <https://fluxer.dev> and operator documentation.

  - type: textarea
    id: issue
    attributes:
      label: Documentation defect
      description: State what the page says and what is correct. For missing content, state what information you needed.
    validations:
      required: true

  - type: input
    id: location
    attributes:
      label: Location
      description: Provide the page URL or file path and heading.
      placeholder: https://fluxer.dev/gateway/overview/
    validations:
      required: false

  - type: textarea
    id: suggestion
    attributes:
      label: Proposed wording
      description: Optional.
    validations:
      required: false

  - type: checkboxes
    id: checks
    attributes:
      label: Acknowledgements
      options:
        - label: I searched open and closed issues.
          required: true