Skip to content

Commit

Permalink
fix: simplify bug and new doc issue templates (#2309)
Browse files Browse the repository at this point in the history
* fix: simplify new doc issue

* fix: simplify bug
  • Loading branch information
thisisjoshford authored Nov 14, 2024
1 parent 40643cb commit 30a7199
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 51 deletions.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/doc-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,6 @@ body:
validations:
required: true

- type: input
id: section
attributes:
label: Section/Heading
placeholder: "e.g., Installation Guide > Prerequisites"
validations:
required: false

- type: textarea
id: current-text
attributes:
label: Current Text
description: If applicable, paste the current problematic text here
placeholder: Paste the current text that needs to be corrected...
validations:
required: false

- type: checkboxes
id: impact
attributes:
Expand Down Expand Up @@ -72,26 +55,3 @@ body:
placeholder: I suggest changing/adding...
validations:
required: false

- type: dropdown
id: browsers
attributes:
label: Browser
description: If this is a layout/rendering issue, what browsers are you seeing the problem on?
multiple: true
options:
- Chrome
- Firefox
- Safari
- Microsoft Edge
- Other
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the problem here, including screenshots if applicable
validations:
required: false
14 changes: 3 additions & 11 deletions .github/ISSUE_TEMPLATE/doc-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,15 @@ body:
id: what
attributes:
label: "What needs documentation?"
placeholder: "Describe what needs to be documented or updated. For existing docs, please provide links."
validations:
required: true

- type: textarea
id: why
attributes:
label: "Why is this documentation needed?"
placeholder: "What problems will this documentation solve? Who will benefit from it?"
placeholder: "Describe what needs to be documented or updated and WHY is it needed."
validations:
required: true

- type: textarea
id: done
attributes:
label: "Documentation Requirements"
placeholder: "What should the documentation include? (e.g., code examples, diagrams, step-by-step guides)"
label: "Acceptance Criteria"
placeholder: "What exactly needs to be done before this issue can be closed? (e.g., code examples, diagrams, step-by-step guides)"
validations:
required: true

Expand Down

0 comments on commit 30a7199

Please sign in to comment.