Skip to content

Commit

Permalink
chore: docs update issue template (#1163)
Browse files Browse the repository at this point in the history
## Description
added docs update template

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)
  • Loading branch information
sgettys authored Jan 9, 2025
1 parent 067df1b commit 21486f9
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: "📄 Documentation Update"
about: Suggest updates or improvements to the documentation
title: ""
labels: ["documentation"]
assignees: ""
---

## Affected Documentation Section

Which section of the documentation needs to be updated?
_(e.g., Getting Started, API Reference, Installation Guide)_
**Section Name or URL:**

---

## Update Details

Describe the changes you'd like to see.
Be as specific as possible, including any examples or corrections.

---

## Why Is This Update Needed?

Explain why this update is important.
Does it fix an error, add missing information, or clarify an existing section?

---

## Additional Context (Optional)

Provide any extra context or links that might help with this update.
_(e.g., links to related issues, screenshots, or relevant resources)_

0 comments on commit 21486f9

Please sign in to comment.