-
-
Notifications
You must be signed in to change notification settings - Fork 534
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add issue and discussion templates for documentation improvements
- Loading branch information
Showing
2 changed files
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for getting in touch! Please fill out this form as completely as possible. | ||
Want to report a problem with the Starlight docs? [Open a new issue](https://github.com/withastro/starlight/issues/new?assignees=&labels=&projects=&template=---02-docs-issue.yml) | ||
Want to chat before posting? [Join us in the `#starlight` channel on Discord](https://astro.build/chat) | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: What is your idea? | ||
description: A brief, one or two sentence description of your idea for how to improve the Starlight docs. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: background | ||
attributes: | ||
label: Why is this important? | ||
description: Explain why this idea is valuable. What problems would it solve? Which users would it help? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: prior-art | ||
attributes: | ||
label: How does your idea relate to existing docs content? | ||
description: Are there specific pages you would like to change? Or existing pages that are related to your proposal? | ||
placeholder: | | ||
- Example | ||
- Example | ||
- Example | ||
- type: checkboxes | ||
id: will-pr | ||
attributes: | ||
label: Participation | ||
description: Let us know if your interested in contributing this feature yourself. | ||
options: | ||
- label: I am willing to submit a pull request for this feature. | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: "\U0001F4DA Docs Issue" | ||
description: Report an issue with the Starlight documentation | ||
labels: [] | ||
assignees: [] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to let us know something is wrong! Please fill out this form as completely as possible. | ||
- type: input | ||
id: docs-page | ||
attributes: | ||
label: What page of the docs did you find an issue on? | ||
description: If this issue applies to multiple pages, include additional pages in your bug description. | ||
placeholder: https://starlight.astro.build/... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the issue | ||
description: A clear and concise description of what the issue is. | ||
validations: | ||
required: true | ||
- type: input | ||
id: os | ||
attributes: | ||
label: What operating system are you using? | ||
placeholder: Mac, Windows, Linux | ||
validations: | ||
required: true | ||
- type: input | ||
id: browser | ||
attributes: | ||
label: What browser are you using? | ||
placeholder: Chrome, Firefox, Safari | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: will-pr | ||
attributes: | ||
label: Participation | ||
options: | ||
- label: I am willing to submit a pull request for this issue. | ||
required: false |