From 1a4a44a223f37671f4c06f608e5ca82cb7df9dd1 Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Thu, 1 May 2025 13:36:17 +1000 Subject: [PATCH] Add docs issue template (#24788) --- .github/ISSUE_TEMPLATE/config.yml | 3 -- .github/ISSUE_TEMPLATE/docs_bug_report.yml | 33 ++++++++++++++++++++++ 2 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/docs_bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 92ab6b5184..6dd27384ad 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,6 +3,3 @@ contact_links: - name: Support Question url: https://docs.px4.io/main/en/contribute/support.html#forums-and-chat about: For questions about using PX4 or related components, please use the discuss forum and discord server - - name: Documentation Issue - url: https://github.com/PX4/PX4-user_guide/issues - about: If you found an issue in documentation, please submit it directly to the docs repository issues diff --git a/.github/ISSUE_TEMPLATE/docs_bug_report.yml b/.github/ISSUE_TEMPLATE/docs_bug_report.yml new file mode 100644 index 0000000000..95de27d2cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_bug_report.yml @@ -0,0 +1,33 @@ +name: 📑 Documentation Bug report +description: Create a report to help us improve the docs +title: "[Docs] [Bug] " +labels: ["Documentation 📑"] +body: + - type: markdown + attributes: + label: Describe the bug + description: A clear and concise description of the bug. + placeholder: | + # A PR to fix the bug is often better than adding this issue! + # + # If you can't create a PR please provide the following: + # - What page and/or section has the problem + # - What is the problem - missing information, incorrect information? + # - Suggested fixes, links to corresponding code PRs + # - Any additional context + validations: + required: true + + - type: input + attributes: + label: Page URL + description: The URL of the problem page. + validations: + required: false + + - type: textarea + attributes: + label: Screenshot / Media + description: Add screenshot / media if you have them + validations: + required: false