diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 0000000..ae5d8e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,31 @@ +name: Documentation Related +description: Report a problem with the user experience when using Supposition.jl +title: "[Doc]: " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + If you have a usage question, please search or post to the [Discussions tab](https://github.com/Seelengrab/Supposition.jl/discussions). + We use the GitHub issue tracker for bug reports, UX problems and feature development only. + - type: textarea + id: doc-location + attributes: + label: Which part of the documentation is this related to? + description: Please give a direct link or quote (both if easily possible) to the section in the documentation this is about. + placeholder: | + In this section () of the doc: + + <...> + + it's unclear/badly worded/lacks background/etc about... + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: How could this be communicated better? + description: Please provide a suggestion on how the (un-)desirable result can be communicated better. + placeholder: I think having a section introducing concept X by itself... It would be good/easier to understand if... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/ux.yml b/.github/ISSUE_TEMPLATE/ux.yml index e8f81cc..b33f7fb 100644 --- a/.github/ISSUE_TEMPLATE/ux.yml +++ b/.github/ISSUE_TEMPLATE/ux.yml @@ -1,5 +1,5 @@ name: UX Problem -description: Report a problem with the user experience +description: Report a problem with the user experience when using Supposition.jl title: "[UX]: " labels: ["UX"] body: