From 1edee621f49f82bf1e5a1d7c3c3a4294c29f461f Mon Sep 17 00:00:00 2001 From: Christine Date: Thu, 26 Oct 2023 17:05:38 +0000 Subject: [PATCH] fix: revise format again --- .github/ISSUE_TEMPLATE/docs.yml | 53 ++++++++++++++++----------------- 1 file changed, 26 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml index c513c58..8bac6c1 100644 --- a/.github/ISSUE_TEMPLATE/docs.yml +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -1,30 +1,29 @@ --- -name: 📄 Documentation issue -about: Found an issue in the documentation? Raise your suggestions here! 😊 +name: "📄 Documentation issue" +description: "Found an issue in the documentation? Raise your suggestions here! 😊" labels: ["📄 aspect: text"] body: - - type: textarea - id: details - attributes: - label: Issue Description - description: Please provide a detailed description of the issue you found in the documentation. Include steps to reproduce the issue and expected vs. actual results. - placeholder: "(e.g., I noticed that [problem])" - validations: - required: true - - type: textarea - id: docs_screenshots - attributes: - label: Screenshots (if applicable) - description: If visual elements are relevant, you can attach screenshots or images. - validations: - required: false - - type: textarea - id: solution - attributes: - label: Proposed Solution - description: Describe your proposed solution to the issue. - placeholder: "(e.g., I suggest [your solution]. This can [add benefit here])" - validations: - required: true - ---- \ No newline at end of file +- type: textarea +id: details +attributes: + label: Problem + description: "Briefly describe the problem you found in our documentation" + placeholder: "(e.g., I noticed that[problem])" +validations: + required: true +- type: textarea +id: docs_screenshots +attributes: + label: screenshots + description: "Please add screenshots if helpful" +validations: + required: false +- type: textarea +id: description +attributes: + label: Possible Solution and Benefit + description: "Describe your solution and how it can help enhance the project" + placeholder: "(e.g., I suggest[your solution]. This can [add benefit here])" +validations: + required: true +---