63 lines
2.2 KiB
YAML
63 lines
2.2 KiB
YAML
name: Documentation
|
|
description: Report unclear, missing, or incorrect REA documentation
|
|
title: "[Docs] "
|
|
labels:
|
|
- documentation
|
|
- triage
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Report one documentation problem with the exact location and the smallest
|
|
useful supporting passage, example, or result. Keep answers concise.
|
|
If something is unknown, write `NOT_ENOUGH_INFO` and explain what is missing.
|
|
|
|
- type: checkboxes
|
|
id: before-submitting
|
|
attributes:
|
|
label: Before submitting
|
|
options:
|
|
- label: I searched the existing issues for a related documentation report.
|
|
required: true
|
|
- label: I removed credentials, tokens, private paths, and sensitive target data.
|
|
required: true
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Documentation location
|
|
description: Link the page, section, command, API, skill, or inline comment.
|
|
placeholder: README.md#quick-start or docs/mcp-contracts.md
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem
|
|
description: Quote or describe the current content, explain what is unclear, missing, outdated, or incorrect, and say how to observe the problem. State who is affected when known.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected-content
|
|
attributes:
|
|
label: Expected content
|
|
description: Describe the accurate behavior or example that should be documented, with a reference when available. Label a proposed clarification or unknown behavior clearly.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: evidence
|
|
attributes:
|
|
label: Supporting evidence
|
|
description: Include an exact passage, source reference, command output, provider documentation, or screenshot supporting the report. For missing or unclear guidance, point to the relevant section and explain the gap. If evidence is unavailable, write NOT_ENOUGH_INFO and explain what is missing.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: additional-context
|
|
attributes:
|
|
label: Additional context
|
|
description: Include screenshots, affected translations, or related issues.
|