Skip to content

Commit

Permalink
Docs issue template. (#7216)
Browse files Browse the repository at this point in the history
### Description

Adding an issue template for docs. Our other issue templates aren't
helpful for a documentation ask.
  • Loading branch information
anthonyshew committed Feb 1, 2024
1 parent 49d3eae commit 21aedd6
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/2-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "Documentation update or improvement"
description: A request to update or improve documentation
title: "Docs: "
labels:
- "template: documentation"
body:
- type: markdown
attributes:
value: Before opening this issue to request a docs improvement, is this something you can help us with? Your contributions are welcomed and appreciated.
- type: markdown
attributes:
value: Thank you for helping us improve the docs!
- type: textarea
attributes:
label: What is the improvement or update you wish to see?
description: "Example: I would like to see more examples of how to use `turbo run`. Or, the `turbo run` docs are missing information."
validations:
required: true
- type: textarea
attributes:
label: Is there any context that might help us understand?
description: A clear description of any added context that might help us understand.
validations:
required: true
- type: input
attributes:
label: Does the docs page already exist? Please link to it.
description: "Example: https://turbo.build/repo/docs/reference/command-line-reference/run"
validations:
required: false

0 comments on commit 21aedd6

Please sign in to comment.