name: Documentation for the Joomla-Component
about: Propose improvements to the documentation or highlight any issues found within it.
title: "[DOCUMENTATION]: "
labels:
  - documentation
body:
  - type: markdown
    attributes:
      value: |
        We appreciate your input on our documentation! Clear and comprehensive documentation plays a vital role in enabling users to effectively interact with our systems. To assist us in making improvements, kindly offer thorough details regarding your suggestion or the specific problem you've encountered.               
  - type: textarea
    id: documentation-details
    attributes:
      label: Documentation Details
      description: Please explain the specific problem with the documentation or the improvements you recommend. Is it a missing topic, unclear instructions, outdated content, or something else?
      placeholder: Detail the issue with the documentation or suggest improvements..
    validations:
      required: true
  - type: markdown
    attributes:
      value: |
        # Specific Context        
  - type: dropdown
    id: system
    attributes:
      label: Which Joomla version does this documentation relate to?
      multiple: true
      options:
        - Joomla 5
        - Joomla 4
        - Joomla 3
    validations:
      required: true
  - type: dropdown
    id: joomla-component_version
    attributes:
      label: Which GetBible/joomla-component version is this documentation related to?
      multiple: true
      options:
        - v5.x
        - v4.x
        - v3.x
        - Other
    validations:
      required: true
  - type: dropdown
    id: area
    attributes:
      label: Which area of the component does this documentation relate to?
      multiple: true
      options:
        - Linkers(admin_views)
        - Notes(admin_views)
        - Tagged Verses(admin_views)
        - Prompts(admin_views)
        - Open AI Responses(admin_views)
        - Tags(admin_views)
        - Translations(admin_views)
        - Books(admin_views)
        - Chapters(admin_views)
        - Verses(admin_views)
        - App(site_vew)
        - Other
    validations:
      required: true
  - type: textarea
    id: expected-outcome
    attributes:
      label: Expected Outcome
      description: What outcomes do you anticipate from this change in documentation? How will it benifit the users or enhance the project?
      placeholder: Explain the expected result of this change in the documentation.
    validations:
      required: true
  - type: textarea
    id: additional-context
    attributes:
      label: Additional Context
      description: Share any extra details, files, or screenshots that could help in understanding or applying the documentation change.
    validations:
      required: false
  - type: textarea
    id: comments
    attributes:
      label: Additional Comments
      description: Feel free to include any further comments or pertinent details that might assist us.