chore: add community and help issue forms

Keep questions and community conversations in GitHub Issues with clear forms and guidance. Remove disabled Discussions links and exempt community topics from stale closure. Closes #1046
2026-11-03 00:11:37 -06:00 · 2026-10-11 05:50:57 +00:00
parent 62cb4f4411
commit b83a181128
7 changed files with 140 additions and 8 deletions
@@ -1,8 +1,5 @@
 blank_issues_enabled: false
 contact_links:
-  - name: Questions and Discussions
-    url: https://github.com/bookorbit/bookorbit/discussions
-    about: Ask questions, get help with your setup, or share how you use BookOrbit
  - name: Documentation
    url: https://bookorbit.app
    about: Read the full documentation at bookorbit.app
@@ -0,0 +1,34 @@
+name: Community Discussion
+description: Discuss workflows and ideas, share your setup, or introduce companion apps
+title: "[Discussion] "
+labels: ["discussion", "needs-triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this space to talk with other BookOrbit users about workflows, ideas, companion apps,
+        integrations, or your setup. You do not need approval or assignment to participate.
+
+        Browse [existing community conversations](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Adiscussion)
+        before starting a new topic. If you need troubleshooting help, use
+        [Question / Help](https://github.com/bookorbit/bookorbit/issues/new?template=question.yml).
+        For a concrete improvement, use the
+        [Feature Request](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml) form.
+
+        Do not share passwords, tokens, private book content, or other sensitive information.
+        Report security vulnerabilities privately using the
+        [security policy](https://github.com/bookorbit/bookorbit/blob/main/.github/SECURITY.md).
+
+  - type: textarea
+    id: topic
+    attributes:
+      label: What would you like to discuss or share?
+      description: Introduce your topic and give enough context for others to join the conversation.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Links, examples, or screenshots (optional)
+      description: Add relevant resources and remove sensitive information from screenshots.
@@ -0,0 +1,59 @@
+name: Question / Help
+description: Ask about setup, configuration, troubleshooting, or using BookOrbit
+title: "[Help] "
+labels: ["support", "needs-triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Questions are welcome, even if you are unsure whether something is a bug.
+        You do not need approval or assignment to ask for help.
+
+        Check the [documentation](https://bookorbit.app) and
+        [existing help requests](https://github.com/bookorbit/bookorbit/issues?q=is%3Aissue%20label%3Asupport)
+        for an answer first. If you still need help, ask here.
+
+        Do not include passwords, tokens, private book content, or other sensitive information in
+        logs or screenshots. Report security vulnerabilities privately using the
+        [security policy](https://github.com/bookorbit/bookorbit/blob/main/.github/SECURITY.md).
+
+        NAS and network storage configurations are unsupported. For storage-related problems,
+        reproduce the problem on supported local storage before asking for troubleshooting help.
+
+  - type: textarea
+    id: question
+    attributes:
+      label: What do you need help with?
+      description: Describe what you want to achieve and where you are stuck.
+    validations:
+      required: true
+
+  - type: textarea
+    id: tried
+    attributes:
+      label: What have you tried? (optional)
+      description: Share any documentation, settings, or troubleshooting steps you have tried.
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Your setup (optional)
+      description: Include the details relevant to your question.
+      placeholder: |
+        - BookOrbit version/image tag:
+        - Deployment: Docker / manual
+        - OS:
+        - Client: web browser / iOS / Kobo / KOReader / other
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant logs (optional)
+      description: Include only relevant excerpts and remove sensitive information before posting.
+      render: shell
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots (optional)
+      description: Remove sensitive information before attaching screenshots.