numfocus · aterrel · Jun 27, 2025 · Jun 10, 2025 · Jun 10, 2025 · Jun 10, 2025
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,70 @@
+name: 🐛 Bug Report
+description: Report a bug to help us improve the DISCOVER Cookbook
+title: "[Bug]: "
+labels: ["🐛 bug", "🧰 maintenance"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thank you for taking the time to fill out this bug report!**
+        To help us resolve this issue as quickly as possible, please provide as much detail as you can.
+
+        Before opening a new issue, please:
+        1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your bug has already been reported.
+        2. **Review our contribution guidelines**: Please read our **[CONTRIBUTING.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md)** before contributing.
+
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the Bug
+      description: "A clear and concise description of what the bug is. What did you see? What did you expect to see?"
+      placeholder: "e.g., The DISC logo is missing from the header of the 'Tags Overview' page, making it inconsistent with other pages."
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: "Please provide detailed steps to reproduce the behavior."
+      placeholder: |
+        1. Go to the DISCOVER Cookbook.
+        2. Click on 'Tags overview' in the navigation menu.
+        3. Observe the header section.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: "A clear and concise description of what you expected to happen."
+      placeholder: "I expected to see the DISC logo displayed in the header of the 'Tags Overview' page."
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots or Screencasts
+      description: "If applicable, add screenshots or a short video to help explain your problem."
+      placeholder: "You can drag and drop images or GIFs here."
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: "Is there anything else you'd like to add? For example, have you tried to fix this yourself? Do you have suggestions for a solution?"
+
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Contribution
+      options:
+        - label: I agree to follow the DISCOVER Cookbook's [Code of Conduct](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: I would like to submit a pull request to fix this bug.
+
diff --git a/.github/ISSUE_TEMPLATE/content_enhancement.yml b/.github/ISSUE_TEMPLATE/content_enhancement.yml
@@ -0,0 +1,89 @@
+name: ✨ Content Enhancement
+description: Propose improvements, updates, new measures, or clarifications for the DISCOVER Cookbook.
+title: "[Enhancement]: "
+labels: ["✨ content enhancement"] 
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thank you for contributing to the DISCOVER Cookbook!** Your suggestions help us keep our content accurate, actionable, and inclusive.
+
+        Before opening a new issue, please:
+        1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your suggestion has already been discussed or is in progress.
+        2. **Review our contribution guidelines**: Please read our **[CONTRIBUTING.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md)** before contributing.
+
+  - type: dropdown
+    id: enhancement-type
+    attributes:
+      label: Type of Enhancement
+      description: What kind of content improvement are you proposing?
+      options:
+        - "Clarification/Rewording (e.g., making text clearer, simplifying language)"
+        - "Adding a new specific example to an existing measure"
+        - "Updating outdated information (e.g., broken links, contact details)"
+        - "Proposing a minor new measure (🍎 or ✅) within an existing section"
+        - "Adding/improving 'Further Reading' resources"
+        - "Structural suggestion (e.g., reordering content within a page)"
+        - "Other (please describe below)"
+    validations:
+      required: true
+
+  - type: input
+    id: relevant-page-url
+    attributes:
+      label: Relevant Page(s) URL (if applicable)
+      description: Please provide the full URL(s) to the page(s) where the enhancement is proposed.
+      placeholder: "e.g., https://discover-cookbook.numfocus.org/04_venue_selection.html"
+    validations:
+      required: true
+
+  - type: textarea
+    id: current-content-snippet
+    attributes:
+      label: Current Content Snippet (Optional, but helpful)
+      description: Copy and paste the specific text or a brief snippet of the section you want to enhance.
+      placeholder: "e.g., 'Consider attendees who may need accommodations for a disability'"
+
+  - type: textarea
+    id: proposed-enhancement
+    attributes:
+      label: Proposed Enhancement / Suggestion
+      description: Describe your suggested improvement in detail. Be specific about new wording, examples, additions, or structural changes.
+      placeholder: |
+        e.g.,
+        For the 'Accessibility Considerations' subsection under 'Venue Selection & On-Site Services', I propose adding a new point:
+
+        ### Create Access Visual & Hearing Disabilities
+        - ✅ Select a venue that has a hearing loop, or audio induction loop (a special type of sound system for use by people with hearing aids) and make sure it is used.
+    validations:
+      required: true
+
+  - type: textarea
+    id: rationale-and-impact
+    attributes:
+      label: Rationale & Expected Impact
+      description: Explain *why* this enhancement is valuable. How does it improve clarity, actionability, inclusivity, or impact for conference organizers or attendees? How does it align with the 🍎 (easy, high impact) or ✅ (more effort, considerable impact) framework?
+      placeholder: "e.g., Adding a guideline about hearing loops significantly enhances accessibility for deaf and hard-of-hearing attendees, making the conference more inclusive. This is a ✅ measure as it requires specific venue selection or setup but has a considerable positive impact."
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-resources
+    attributes:
+      label: Additional Resources / Further Reading 
+      description: Provide links to external resources, research, or examples that support your suggestion.
+      placeholder: "e.g., [https://www.hearinglink.org/technology/hearing-loops/what-is-a-hearing-loop/](https://www.hearinglink.org/technology/hearing-loops/what-is-a-hearing-loop/)"
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: willingness-to-contribute
+    attributes:
+      label: Contribution
+      options:
+        - label: I agree to follow the DISCOVER Cookbook's [Code of Conduct](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: I would be willing to draft a pull request to implement this enhancement.
+
diff --git a/.github/ISSUE_TEMPLATE/new_chapter_proposal.yml b/.github/ISSUE_TEMPLATE/new_chapter_proposal.yml
@@ -0,0 +1,121 @@
+name: 📖 New Chapter Proposal
+description: Propose a new chapter or significant content addition for the DISCOVER Cookbook.
+title: "[New Chapter Proposal]: "
+labels: ["✍️ new content" , "📖 new chapter"]
+assignees: [] 
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thank you for your interest in contributing to the DISCOVER Cookbook!**
+
+        Please use this template to propose a new chapter or a substantial content addition. Providing thorough details will help us understand your idea and facilitate a quicker review process.
+
+        Before opening a new issue, please:
+        1. **Search [existing issues](https://github.com/numfocus/DISCOVER-Cookbook/issues)**: Check if your suggestion has already been discussed or is in progress.
+        2. **Review our contribution guidelines**: Please read our **[CONTRIBUTING.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md)** before contributing.
+
+
+  - type: textarea
+    id: problem-statement
+    attributes:
+      label: 1. Problem/Gap Addressed
+      description: "What problem does this new chapter solve, or what gap in the existing DISCOVER Cookbook content does it fill? Why is this chapter needed now?"
+      placeholder: "e.g., The Cookbook lacks comprehensive guidance on managing accessibility for virtual attendees, which is increasingly relevant for hybrid events."
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: 2. Proposed Chapter Title & Brief Description
+      description: "What is your proposed title for the new chapter? Provide a concise summary of its content and main objectives."
+      placeholder: "e.g., Title: 'Virtual & Hybrid Event Accessibility'. Description: This chapter will provide practical guidelines for ensuring virtual and hybrid events are accessible to all participants, covering digital tools, captioning, and time zone considerations."
+    validations:
+      required: true
+
+  - type: dropdown
+    id: chapter-type
+    attributes:
+      label: 3. Chapter Type (Diátaxis Framework)
+      description: "Following the Diátaxis framework, what type of documentation will this chapter primarily be? (Select the best fit. See(https://diataxis.fr/) for definitions.)"
+      options:
+        - "Tutorial (Learning-oriented, guides through a process step-by-step)"
+        - "How-to Guide (Goal-oriented, steps for a specific task)"
+        - "Explanation (Understanding-oriented, discusses concepts and principles)"
+        - "Reference (Information-oriented, technical specifications or detailed facts)"
+      default: 1 # Default  How-to Guide 
+    validations:
+      required: true
+
+  - type: textarea
+    id: target-audience
+    attributes:
+      label: 4. Target Audience
+      description: "Who is the primary audience for this chapter? (e.g., Event organizers, tech support teams, speakers, virtual attendees)"
+      placeholder: "e.g., Event organizers, AV teams, and platform administrators planning virtual or hybrid components."
+    validations:
+      required: true
+
+  - type: textarea
+    id: key-topics
+    attributes:
+      label: 5. Key Topics & Outline
+      description: "List the main sections and key topics you plan to cover in this chapter. Provide a brief outline or bullet points. If proposing new 🍎 (easy, high impact) or ✅ (more effort, considerable impact) measures, indicate them here."
+      placeholder: |
+        - Introduction to virtual accessibility principles
+        - Digital platform accessibility (WCAG compliance, screen reader compatibility)
+        - Live captioning and sign language interpretation for virtual sessions (✅)
+        - Time zone considerations for global participation (🍎)
+        - Accessible presentation materials (slides, documents)
+        - Post-event accessibility (recordings, transcripts)
+    validations:
+      required: true
+
+  - type: textarea
+    id: existing-content-integration
+    attributes:
+      label: 6. Integration with Existing Cookbook Content
+      description: "How does this proposed chapter relate to or integrate with existing sections of the DISCOVER Cookbook? Are there any existing chapters it would link to, expand upon, or replace?"
+      placeholder: "e.g., This chapter would complement 'Venue Selection & On-Site Services' by extending accessibility to virtual spaces. It could link to 'Participant and Speaker Selection' for inclusive speaker guidelines in a virtual context."
+    validations:
+      required: true
+
+  - type: textarea
+    id: value-proposition
+    attributes:
+      label: 7. Value Proposition / Expected Impact
+      description: "What value will this chapter bring to the DISCOVER Cookbook and its users? How will its success be measured?"
+      placeholder: "e.g., It will make the Cookbook relevant for modern event formats, significantly increasing accessibility for remote participants and broadening the Cookbook's reach and impact."
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggested-tags
+    attributes:
+      label: 8. Suggested Tags (from `_tags/` directory)
+      description: "Based on the existing `_tags/` directory (e.g., `_tags/mobility-impairment.md`), which tags would be most relevant for this new content?"
+      placeholder: "e.g., Digital-Accessibility, Virtual-Events, Hearing-Impairment, Visual-Impairment, Global-South"
+
+  - type: textarea
+    id: additional-resources
+    attributes:
+      label: 9. Additional Resources / Further Reading 
+      description: "Provide links to external resources, research, or examples that could be referenced in this new content."
+      placeholder: |
+        - W3C Web Content Accessibility Guidelines (WCAG): Core guidelines for digital accessibility. [https://www.w3.org/WAI/WCAG21/quickref/](https://www.w3.org/WAI/WCAG21/quickref/)
+        - Zoom Accessibility Features: Official guide to accessibility options within Zoom. [https://explore.zoom.us/docs/en-us/accessibility.html](https://explore.zoom.us/docs/en-us/accessibility.html)
+
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Contribution 
+      description: "By submitting this proposal, you agree to the following:"
+      options:
+        - label: I am willing to collaborate with maintainers and other contributors on this chapter.
+          required: true
+        - label: I agree to follow the DISCOVER Cookbook's [Code of Conduct](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: I would be willing to draft a pull request to implement this enhancement.
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,35 @@
+## Description of Changes
+
+<!-- Clearly and concisely describe the changes introduced by this Pull Request.
+     What problem does it solve? What new content or improvements does it bring? -->
+
+
+## Related Issue
+
+<!-- Link this Pull Request to the relevant GitHub Issue.
+     Use keywords like `Closes #<issue-number>`, `Fixes #<issue-number>`, or `Resolves #<issue-number>`
+     to automatically close the issue when the PR is merged.
+     [Learn more](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). -->
+
+
+## Type of Change
+
+Please check the appropriate box that describes your PR:
+
+- [ ] 🐛 Bug Fix — Fixes a documented issue or incorrect behavior
+- [ ] ✨ Content Enhancement — Updates or improves existing content
+- [ ] ✍️ New Content — Adds new chapters, examples, or significant sections
+- [ ] 🛠️ Other — Please describe in the *Description of Changes* section
+
+
+## Additional Notes (Optional)
+
+<!-- Add any other relevant context or information about the changes here.
+     Include screenshots or references if helpful. -->
+
+
+## Checklist
+
+- [ ] I have searched [open pull requests](https://github.com/numfocus/DISCOVER-Cookbook/pulls) to avoid duplicates.
+- [ ] I have built the book locally using the [build instructions](https://github.com/numfocus/DISCOVER-Cookbook#how-to-run-the-book-locally) and verified my changes work as expected.
+- [ ] I have written clear, conventional commit messages, as per the [Pull Request Guidelines](https://github.com/numfocus/DISCOVER-Cookbook/blob/main/CONTRIBUTING.md#pull-request-guidelines).