|
| 1 | +name: Docs bug report |
| 2 | +description: Report documentation defects (incorrect, missing, outdated, or contradictory docs). |
| 3 | +title: "[Docs Bug]: " |
| 4 | +labels: |
| 5 | + - bug |
| 6 | + - docs |
| 7 | +body: |
| 8 | + - type: markdown |
| 9 | +attributes: |
| 10 | +value: | |
| 11 | + Report a documentation defect with concrete evidence from current docs behavior/content. |
| 12 | + Please only report one documentation defect per submission. |
| 13 | + - type: textarea |
| 14 | +id: summary |
| 15 | +attributes: |
| 16 | +label: Summary |
| 17 | +description: One-sentence statement of what is wrong in the docs. |
| 18 | +placeholder: The WhatsApp config example defines duplicate top-level keys in one JSON5 block. |
| 19 | +validations: |
| 20 | +required: true |
| 21 | + - type: input |
| 22 | +id: doc_paths |
| 23 | +attributes: |
| 24 | +label: Affected docs path(s) or URL(s) |
| 25 | +description: Repo-relative docs file path(s) or published docs URL(s). |
| 26 | +placeholder: docs/gateway/config-channels.md or https://docs.openclaw.ai/gateway/config-channels |
| 27 | +validations: |
| 28 | +required: true |
| 29 | + - type: textarea |
| 30 | +id: repro |
| 31 | +attributes: |
| 32 | +label: Steps to reproduce / verify |
| 33 | +description: Minimal steps to observe the docs defect in the current docs. |
| 34 | +placeholder: | |
| 35 | + 1. Open docs/gateway/config-channels.md |
| 36 | + 2. Go to the WhatsApp example block |
| 37 | + 3. Observe duplicate top-level key definitions |
| 38 | + validations: |
| 39 | +required: true |
| 40 | + - type: textarea |
| 41 | +id: expected |
| 42 | +attributes: |
| 43 | +label: Expected docs behavior/content |
| 44 | +description: What the docs should say/show instead. |
| 45 | +placeholder: The example should use a single merged top-level object with no duplicate keys. |
| 46 | +validations: |
| 47 | +required: true |
| 48 | + - type: textarea |
| 49 | +id: actual |
| 50 | +attributes: |
| 51 | +label: Actual docs behavior/content |
| 52 | +description: What the docs currently say/show. |
| 53 | +placeholder: The snippet defines the same top-level key twice in one object. |
| 54 | +validations: |
| 55 | +required: true |
| 56 | + - type: textarea |
| 57 | +id: impact |
| 58 | +attributes: |
| 59 | +label: Impact |
| 60 | +description: Who is affected and practical consequence. |
| 61 | +placeholder: Users who copy-paste the snippet can end up with ambiguous config behavior. |
| 62 | +validations: |
| 63 | +required: true |
| 64 | + - type: textarea |
| 65 | +id: evidence |
| 66 | +attributes: |
| 67 | +label: Evidence |
| 68 | +description: Links/snippets/screenshots proving the docs defect. |
| 69 | +placeholder: Include exact file links and line ranges. |
| 70 | +validations: |
| 71 | +required: true |
| 72 | + - type: textarea |
| 73 | +id: additional_information |
| 74 | +attributes: |
| 75 | +label: Additional information |
| 76 | +description: Optional context, related issues/PRs, or constraints. |
