36 lines
1.0 KiB
YAML
36 lines
1.0 KiB
YAML
name: Documentation
|
|
about: Report missing, incorrect, or outdated documentation in this repo
|
|
labels:
|
|
- "type: docs"
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Use this for documentation issues within this repository (README, inline docs, API docs, setup guides).
|
|
For product-level documentation requests, use [Evercatch Board](https://git.psmattas.com/Evercatch/evercatch-board/issues).
|
|
- type: input
|
|
id: page
|
|
attributes:
|
|
label: Affected Page / File
|
|
placeholder: e.g. README.md, monitoring/README.md, app/api/v1/webhooks.py
|
|
validations:
|
|
required: true
|
|
- type: dropdown
|
|
id: type
|
|
attributes:
|
|
label: Type
|
|
options:
|
|
- Missing documentation
|
|
- Incorrect / outdated information
|
|
- Unclear or confusing
|
|
- Typo / formatting
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: What needs to change and why?
|
|
validations:
|
|
required: true
|