From fe1ba1bda74ba183c2d166dfebf6eb8e56bb8626 Mon Sep 17 00:00:00 2001 From: WadydX <65117428+WadydX@users.noreply.github.com> Date: Sun, 3 May 2026 13:22:14 +0100 Subject: [PATCH] meta(issue-template): add dedicated docs bug report form --- .github/ISSUE_TEMPLATE/docs_bug_report.yml | 75 ++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs_bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/docs_bug_report.yml b/.github/ISSUE_TEMPLATE/docs_bug_report.yml new file mode 100644 index 000000000000..2c44696a0584 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_bug_report.yml @@ -0,0 +1,75 @@ +name: Docs bug report +description: Report documentation defects (incorrect, missing, outdated, or contradictory docs). +title: "[Docs Bug]: " +labels: + - bug + - docs +body: + - type: markdown + attributes: + value: | + Report a documentation defect with concrete evidence from current docs behavior/content. + - type: textarea + id: summary + attributes: + label: Summary + description: One-sentence statement of what is wrong in the docs. + placeholder: The WhatsApp config example defines duplicate top-level keys in one JSON5 block. + validations: + required: true + - type: input + id: doc_paths + attributes: + label: Affected docs path(s) + description: Repo-relative docs file path(s). + placeholder: docs/gateway/config-channels.md + validations: + required: true + - type: textarea + id: repro + attributes: + label: Steps to reproduce / verify + description: Minimal steps to observe the docs defect in the current docs. + placeholder: | + 1. Open docs/gateway/config-channels.md + 2. Go to the WhatsApp example block + 3. Observe duplicate top-level key definitions + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected docs behavior/content + description: What the docs should say/show instead. + placeholder: The example should use a single merged top-level object with no duplicate keys. + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual docs behavior/content + description: What the docs currently say/show. + placeholder: The snippet defines the same top-level key twice in one object. + validations: + required: true + - type: textarea + id: impact + attributes: + label: Impact + description: Who is affected and practical consequence. + placeholder: Users who copy-paste the snippet can end up with ambiguous config behavior. + validations: + required: true + - type: textarea + id: evidence + attributes: + label: Evidence + description: Links/snippets/screenshots proving the docs defect. + placeholder: Include exact file links and line ranges. + validations: + required: true + - type: textarea + id: additional_information + attributes: + label: Additional information + description: Optional context, related issues/PRs, or constraints.