Files
APIPark/.github/ISSUE_TEMPLATE/docs_issue.yml
2024-08-15 11:34:33 +08:00

33 lines
1.1 KiB
YAML

name: "Documentation Issue"
description: Issues related to documentation.
title: "docs: "
labels: [doc]
body:
- type: markdown
attributes:
value: |
_The more information you share, the faster we can help you._
Prior to opening the issue, please make sure that you:
- Use English to communicate.
- Search the [open issues](https://github.com/APIParkLab/APIPark/issues) and [discussion forum](https://github.com/APIParkLab/APIPark/discussions) to avoid duplicating the issue.
- type: textarea
id: current-state
attributes:
label: Current State
description: Describe the current state of the documentation.
placeholder: |
The documentation for the API in this page (url) is missing ...
validations:
required: true
- type: textarea
id: desired-state
attributes:
label: Desired State
description: Describe the desired state the documentation should be in.
placeholder: |
There should be line mentioning how the API behaves when ...
validations:
required: true