|
| 1 | +name: "Documentation Report" |
| 2 | +description: "Report errors or suggest improvements for project documentation." |
| 3 | +labels: "documentation" |
| 4 | +body: |
| 5 | + - type: markdown |
| 6 | + attributes: |
| 7 | + value: "**Thank you for helping us improve our documentation! Please complete the following information to help us address the issue efficiently.**" |
| 8 | + |
| 9 | + - type: textarea |
| 10 | + id: description |
| 11 | + attributes: |
| 12 | + label: "Description" |
| 13 | + description: "Explain the problem or the section that needs improvement in the documentation." |
| 14 | + placeholder: "Describe the documentation issue here..." |
| 15 | + validations: |
| 16 | + required: true |
| 17 | + |
| 18 | + - type: textarea |
| 19 | + id: affected_section |
| 20 | + attributes: |
| 21 | + label: "Affected Section" |
| 22 | + description: "Indicate which part of the documentation contains the error. This can be specified using a URL, section, or specific page." |
| 23 | + placeholder: "E.g., https://example.com/docs/section or 'Installation Guide' section or page 3 of PDF manual..." |
| 24 | + validations: |
| 25 | + required: true |
| 26 | + |
| 27 | + - type: textarea |
| 28 | + id: error_found |
| 29 | + attributes: |
| 30 | + label: "Error Found" |
| 31 | + description: "Describe what is wrong. This could be: lack of clarity, spelling/grammar errors, outdated information, or missing information." |
| 32 | + placeholder: "Detail the specific error or issue found..." |
| 33 | + validations: |
| 34 | + required: true |
| 35 | + |
| 36 | + - type: textarea |
| 37 | + id: improvement_proposal |
| 38 | + attributes: |
| 39 | + label: "Improvement Proposal (optional)" |
| 40 | + description: "How should the documentation be corrected or improved?" |
| 41 | + placeholder: "Suggest how the documentation could be improved..." |
| 42 | + validations: |
| 43 | + required: false |
| 44 | + |
| 45 | + - type: textarea |
| 46 | + id: error_evidence |
| 47 | + attributes: |
| 48 | + label: "Evidence of Error (optional)" |
| 49 | + description: "Provide evidence of the error, such as screenshots, manual captures, videos, or examples." |
| 50 | + placeholder: "Upload or describe evidence of the documentation issue..." |
| 51 | + validations: |
| 52 | + required: false |
| 53 | + |
| 54 | + - type: checkboxes |
| 55 | + id: submission_checklist |
| 56 | + attributes: |
| 57 | + label: "Submission Checklist" |
| 58 | + description: "Please confirm the following before submitting:" |
| 59 | + options: |
| 60 | + - label: "I have verified that this documentation issue hasn't been reported previously." |
| 61 | + required: true |
| 62 | + - label: "I have provided specific details about the location of the issue in the documentation." |
| 63 | + required: true |
| 64 | + - label: "The information I've provided is accurate and clear." |
| 65 | + required: true |
0 commit comments